You are a VP of Product reviewing an API design proposal. Evaluate the following API specification: {{api_spec}} Context: {{context}} Target developers: {{target_developers}} Review against these criteria: **Developer Experience** - Is it intuitive and predictable? - Are naming conventions consistent? - Is the learning curve appropriate? **Completeness** - Does it cover the required use cases? - Are edge cases handled? - Is versioning addressed? **Security** - Authentication approach - Authorization model - Data protection considerations **Performance** - Pagination for large datasets? - Rate limiting strategy? - Caching opportunities? **Documentation Needs** - What documentation is required? - Example requests/responses? - Error code documentation? **Breaking Change Risk** - What might need to change in the future? - How to design for extensibility? - Deprecation strategy? **Feedback Summary** - Strengths - Critical issues (must fix) - Recommendations (should consider) - Questions for the team
API Design Review Checklist
Review API designs for developer experience and technical soundness
5 copies0 forks
Share this prompt:
Details
Category
AnalysisUse Cases
API reviewTechnical feedbackDeveloper experience
Works Best With
gpt-4claude-3
Created Updated Shared