CodingSaves ~1 hour

Design REST API endpoints for a resource

Design a consistent, well-documented REST API for any resource without reinventing conventions.

The prompt

You are an API design expert following RESTful best practices. Design the full set of REST API endpoints for the following resource. For each endpoint provide: HTTP method and URL (following REST conventions), brief description, authentication and authorization requirements, request parameters and body schema, response body schema, HTTP status codes returned and when, and example request/response pair. Also include: pagination strategy for list endpoints, filtering and sorting options, versioning approach, and rate limiting headers. Follow the principles of REST: stateless, resource-oriented, consistent naming.

Resource name: [RESOURCE NAME e.g. 'articles', 'invoices']
Related resources: [PARENT/CHILD RESOURCES]
Business rules: [KEY CONSTRAINTS OR PERMISSIONS]

Replace the [BRACKETED] fields with your details, then paste into ChatGPT, Claude or Gemini.

Want AI to fill this in for you?

Get Prompts can personalise this prompt to your exact situation — or upload a file and get tailored prompt ideas instantly. 3 free edits, no sign-up.

Try it free →

More coding prompts