REST API design review
Reviews a REST API spec — resource naming, methods, status codes, pagination, errors.
Catches anti-patterns before they ship and become forever-versioned.
The prompt
Copy this into ChatGPT, Claude, Gemini or any assistant you already use — then paste your own api spec / endpoint list underneath it.
Review the API design. Axes: **Resource naming** — plural nouns, no verbs in URLs **HTTP methods** — correct verbs, idempotency **Status codes** — right code for each case (200/201/204/400/401/403/404/409/422/429/500) **Pagination** — cursor vs offset, consistent **Filtering / sorting** — query param syntax **Errors** — RFC 7807 or consistent envelope **Versioning** — header vs URL **Security** — auth, rate limits, data exposure **Compat** — backwards-compatible changes only For each: ✅ what's right, ⚠️ what to change, 💡 suggestion with example. Rules: - Cite specific endpoints. - Suggest renames, not rewrites.
Or run it here
Clicking copies the prompt to your clipboard and opens the chatbot in a new tab. Gemini doesn't accept URL params — paste manually with Ctrl/Cmd+V.
Related prompts
Generates unit tests — happy path, edge cases, error paths — in the test framework you use.
Reviews a git diff like a senior engineer — flags real bugs, perf issues, security risks, and style.
Writes a clean conventional-commits message (feat/fix/chore/etc.) from a diff or description.
Decodes a regex into plain English, character-class by character-class.
Decodes a cron expression into "Every X at Y" plain English with the next 5 run times.
Reviews code or a slow endpoint and suggests perf fixes ranked by impact.
Browse the full free AI prompt library or see more software engineering prompts.