Design a Clean REST API for a New Resource
Get a complete REST endpoint design with shapes, errors, and idempotency notes.
§ The Prompt— ready to copy
rest-api-design.prompt
Design REST endpoints for a new resource: [RESOURCE NAME]. Use cases: [LIST]. Authentication style: [JWT/API KEY/OAUTH]. For each endpoint provide: method, path, request body shape (TypeScript or JSON), response shape, possible error codes, idempotency notes. Follow REST conventions strictly. Flag any case where REST is awkward and a different style would be better.
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