Back to guide/Developer Tools

API Design Review

Get comprehensive API design feedback covering REST conventions, error handling, and auth patterns.

api-designcross-modelarchitecture
Edit View
Prompt
Review this API design for a {{domain}} service:

Endpoints:
{{list your endpoints}}

For each endpoint, evaluate:
- REST conventions (HTTP methods, status codes, URL structure)
- Request/response payload design
- Error handling consistency
- Authentication and authorization approach
- Pagination and filtering patterns

Suggest improvements with concrete examples. Flag any breaking changes that would affect existing clients.

Variables to customize

{{domain}}{{list your endpoints}}

Why this prompt works

Domain context helps both models give relevant advice. The evaluation checklist ensures comprehensive coverage rather than surface-level review.

Save this prompt to your library

Organize, version, and access your best prompts across ChatGPT, Claude, and Cursor.

Related prompts

Code Review Assistant

Get thorough code reviews with actionable feedback tailored to your language, framework, and standards.

Code Review with Specific Criteria

Get focused code review feedback with numbered criteria that works on both ChatGPT and Claude.

Explain Complex Code

Get a clear, leveled explanation of any code snippet — calibrated to your experience level.

Debug with Context

Systematic debugging prompt that includes context, error details, and what you've already tried.