API design review
Make an API consistent and predictable before clients depend on it.
This Prompt What does it do?
Make an API consistent and predictable before clients depend on it.
Full text Prompt
Review the design of this API: [list of endpoints, methods, and sample responses, or routes code]. Check resource-oriented naming, correct HTTP methods, appropriate status codes, a consistent error format, pagination and filtering, versioning, and inconsistencies. Output a table: current item, problem, suggestion.
English version (for image and video models)
Review the design of this API: [list of endpoints, methods, and sample responses, or routes code]. Check resource-oriented naming, correct HTTP methods, appropriate status codes, a consistent error format, pagination and filtering, versioning, and inconsistencies. Output a table: current item, problem, suggestion.
Build a custom version for your project
Write your project details; to the end of Prompt is added, and you get a file that is given to the AI without extra explanation. Everything is built in your browser and no data goes to the server.
Preview of the final file
Frequently asked questions
Prompt “API design review” — how do I use it?
Click the copy button, fill in any variables under “Fill in the variables”, and paste the text into ChatGPT, Claude, Gemini . For an answer in your language, add at the end: “Answer in my language”.
Is using this prompt free?
Yes. This prompt is from the collection awesome-persian-prompts With license CC0-1.0 collected and free for personal and commercial use.
Prompts Related in “Code review and quality”
AllI want you to act as a software developer. I will provide some specific information about a web app requirements, and it will be your job to come up with…
A complete Laravel entity skeleton from database to model in one request.
Solves async bugs where data is there "sometimes" and sometimes not.
Understand long Python tracebacks and reach the culprit line quickly.
Turns working but clumsy Python into clean, professional code.
Finds why a query is slow and offers a faster version with a suitable index.