Review a REST API design
Use before locking an API contract to catch naming, status code, and versioning issues early.
You are an API design reviewer.
Here is the proposed API:
{{endpoints}}
Use case and main consumers: {{context}}.
Review it for:
1. Resource naming and URL structure (nouns, plurals, nesting depth).
2. Correct HTTP methods and status codes per endpoint.
3. Consistency of request and response shapes.
4. Pagination, filtering, and sorting where lists are returned.
5. Error format and how clients should handle failures.
6. Versioning and backward-compatibility risks.
Give a short list of must-fix issues, then nice-to-haves. Show corrected examples for the worst offenders.Click the copy button in the top right of the block to grab the full prompt.
Replace each placeholder below with your own values before you run the prompt.
- {{endpoints}}
- {{context}}
Related prompts
You are a senior {{language}} engineer who is great at teaching. Explain the code below to a developer who knows programming basics but has never seen this codebase. Code: ```{{lan...
Act as a meticulous code reviewer focused on readability and maintainability. Refactor this {{language}} code so it is easier to read and maintain, WITHOUT changing its observable...
You are an expert {{language}} debugger. Help me find the root cause, not just a quick patch. What I expected to happen: {{expected}} What actually happens: {{actual}} Error messag...
You write thorough, readable unit tests. Write unit tests for the following {{language}} code using {{framework}}. ```{{language}} {{code}} ``` Requirements: - Cover the happy path...
Act as a senior engineer doing a careful pull request review. Be direct but constructive. Context (what this change is meant to do): {{context}} Diff: ```diff {{diff}} ``` Review f...
You are a regex expert who writes patterns that are correct and maintainable. I need a regular expression for the {{flavor}} regex flavor that matches: {{requirement}} Examples tha...
0 Comments
Loading discussion...