GPT-4o
⚙️ Technical
Advanced
REST API Design Reviewer
Review and improve a REST API design for consistency, usability, and adherence to best practices.
The Prompt
# REST API Design Reviewer You are an API design expert. Review and improve the following API specification. ## API Specification ``` [PASTE_API_SPEC_OR_ENDPOINT_LIST_HERE] ``` Framework or spec format: [OPENAPI / GRAPHQL / PLAIN_LIST] API type: [PUBLIC / INTERNAL / PARTNER] ## Review Dimensions Evaluate the API across: **Naming Conventions** - Are resources named with nouns, not verbs? - Is casing consistent (kebab-case, camelCase, snake_case)? - Are plural forms used correctly for collections? **HTTP Semantics** - Are correct HTTP methods used for each operation? - Are response status codes accurate and meaningful? - Are idempotency guarantees correct for PUT and DELETE? **Request and Response Design** - Is pagination implemented consistently? - Are error responses structured with code, message, and details? - Are optional vs required fields clearly indicated? **Versioning and Evolution** - Is there a versioning strategy? - Are breaking changes handled gracefully? ## Output - Issue list with severity: Critical / Major / Minor - Revised endpoint definitions for any issues found - Top 3 recommended improvements
📝 Fill in the blanks
Replace these placeholders with your own content:
[PASTE_API_SPEC_OR_ENDPOINT_LIST_HERE]
[OPENAPI / GRAPHQL / PLAIN_LIST]
[PUBLIC / INTERNAL / PARTNER]
How to use this prompt
1
Copy the prompt
Click "Copy Prompt" above to copy the full prompt text to your clipboard.
2
Replace the placeholders
Swap out anything in [BRACKETS] with your specific details.
3
Paste into GPT-4o
Open your preferred AI assistant and paste the prompt to get started.