API Design Reviewer
PROAudit REST and GraphQL APIs for consistency, scalability, security, and adherence to best practices before deployment.
Example Usage
Review this REST API design for a user management service. The endpoint is GET /api/v1/users/{id}/profile. Check for consistency with RESTful naming conventions, verify appropriate HTTP status codes, validate error response structure follows RFC 9457 Problem Details format, and flag any security concerns like exposed sensitive fields.
Skill Prompt
This skill works best when copied from findskill.ai — it includes variables and formatting that may not transfer correctly elsewhere.
How to Use This Skill
1
Copy the skill using the button above
2
Paste into your AI assistant (Claude, ChatGPT, etc.)
3
Fill in your inputs below (optional) and copy to include with your prompt
4
Send and start chatting with your AI
Suggested Customization
| Description | Default | Your Value |
|---|---|---|
| URL to organizational API style guide for validation | https://opensource.zalando.com/restful-api-guidelines/ | |
| Default records per page for pagination review | 20 | |
| Maximum allowed records per request | 1000 | |
| Required authentication mechanism | oauth2 | |
| Maximum allowed GraphQL query complexity score | 1000 | |
| Time window for rate limiting | 3600 |
Audit REST and GraphQL APIs for consistency, scalability, security, and adherence to best practices. Get detailed review reports with actionable recommendations before deployment.
Research Sources
This skill was built using research from these authoritative sources:
- Enhancing Data Query Flexibility with GraphQL GraphQL vs REST performance characteristics and schema optimization
- REST API Design and Specification Practices Empirical research on real-world API design challenges
- Performance Evaluation of Microservices Communication Benchmark comparing REST, GraphQL, and gRPC performance
- How to Conduct API Design Reviews Practical guide on implementing API review processes
- API Design Patterns for Scalable Systems Resource-based patterns, pagination, and scalability approaches
- GraphQL API Design Best Practices GraphQL-specific schema optimization and error handling
- API Design Reviews Don't Have to be Hard Systematic review methodology and documentation assessment
- OpenAPI Specification v3.1.0 Official machine-readable API description standard