Design a RESTful API Endpoint Schema
Design a complete REST API schema with request/response bodies, status codes, and error cases.
§ The Prompt— ready to copy
api-design-rest.prompt
You are a senior backend engineer. Design the REST API for [FEATURE/RESOURCE]. For each endpoint provide: HTTP method, path, path/query parameters, request body schema (JSON), response body schema (JSON), success status code, and at least 2 error cases with status codes and error payloads. Follow RESTful conventions. Flag any tricky design decisions with a short explanation of the tradeoff.
Replace anything in [BRACKETS] with your specifics before sending.
Best For — Roles
Use For — Tasks
§ Related Entries
You may also need
№ 002coding
Perform a Thorough Code Review on a Pull Request
Get a senior-engineer-style code review with categorized, file-referenced feedback.
For
claude·chatgpt
№ 021coding
Refactor Code for Readability and Maintainability
Refactor any code for readability and maintainability without changing its behavior.
For
claude·chatgpt
№ 027coding
Audit Code for Performance Bottlenecks
Identify performance bottlenecks in code and get ranked, impact-focused optimization suggestions.
For
claude·chatgpt
№ 028coding
Run a Security Review on Code
Get an OWASP-aligned security review with severity ratings and remediation snippets.
For
claude·chatgpt