Design a REST API
Endpoint-by-endpoint design including the error responses most API specs forget.
Advanced1 min read
Customize
Fill these in and the prompt below updates as you type. Anything you leave blank stays as a placeholder.
The single noun this is built around
The actions this needs to support
How users are authenticated
Limits the answer must respect
Your prompt
Design a REST API for a {{resource}} resource. Operations needed: {{operations}} Auth model: {{auth_model}} Constraints: {{constraints}} For each endpoint give: method + path, request body schema, success response + status code, and the ERROR responses (validation, auth, not found, conflict) with status codes. Then list 3 edge cases the design must handle and how. Use JSON for the schemas.