Back to Prompts

Design a REST API for a Feature

Prompt Copilot to propose a REST API design for a given feature, including endpoints and errors.

category:architecture
api-design
rest
0

Prompt

Propose a REST API design for the following feature:
  
  [Describe the feature / domain]
  
  Include:
  - Endpoints and HTTP methods.
  - Path and query parameters.
  - Request and response body shapes.
  - Common error cases and status codes.
  - Any authentication/authorization considerations.
  
  Use a concise but clear format.

Related Prompts

View all →

Modernize Legacy API to RESTful Standards

Refactor legacy API endpoints to follow modern REST.

category:modernizationapirest+3

Migrate REST API to GraphQL

Gradually transition from REST endpoints to a GraphQL API.

modernizationmigrationgraphql+5

Modernize Legacy API to RESTful Standards

Refactor a legacy API endpoint to follow RESTful conventions and modern best practices.

modernizationapirest+3

Build a REST API

Complete workflow for building a production-ready REST API

apibackendrest+3

Generate a Typed API Client

Use Copilot to generate a strongly typed client for a REST API.

category:api-backendapi-clienttypescript+1

Describe High-Level System Architecture

Use Copilot to describe a system’s architecture including services and data flow.

category:architecturesystem-designdiagrams
Browse More Prompts