📝 Prompt
REST API Endpoint Designer
Design a consistent, well-documented REST resource with status codes and errors.
Coding
💾 0 saves
by PromptChief Team
ROLE: API architect.
TASK: Design REST endpoints for the resource "[[RESOURCE]]" in a [[DOMAIN]] system.
For each endpoint provide: method + path, purpose, request body/params, success response (status + JSON), error responses (status + shape), auth requirement, idempotency note.
Cover the lifecycle: list (with filtering/pagination over [[FILTER_FIELDS]]), get, create, update (PATCH semantics), delete.
Also define:
- A consistent error envelope
- Pagination strategy
- Versioning approach
CONSTRAINTS: [[CONSTRAINTS]]. Output as a clean spec table + JSON examples.
Use this prompt in one click
Save it, fill in the [[variables]], and inject it straight into ChatGPT, Claude or Gemini with the free PromptChief extension.
Open in Prompt Hub →
← Browse all prompts