API Design Reviewer
Skill Verified ActiveAPI Design Reviewer
To help engineering teams build consistent, maintainable, and well-designed APIs through automated analysis and adherence to best practices.
Features
- Analyzes API designs against REST conventions and best practices
- Detects breaking changes between API versions
- Scores API design quality across multiple dimensions
- Enforces naming conventions and URL structures
- Validates HTTP method usage and status codes
Use Cases
- Reviewing new API designs for adherence to standards
- Identifying potential issues before releasing new API versions
- Assessing the quality and consistency of existing APIs
- Improving the developer experience of RESTful APIs
Non-Goals
- Generating API specifications from scratch
- Testing API functionality
- Deploying or managing APIs
Workflow
- Analyze API specification file (OpenAPI/Swagger or raw endpoints)
- Identify deviations from REST conventions and best practices
- Detect breaking changes between API versions
- Generate a comprehensive report with issues, suggestions, and a quality score
- Use the report to improve API design and ensure backward compatibility
Practices
- API Design Consistency
- RESTful Principles
- API Versioning
- Error Handling Standards
- Security Best Practices
Installation
First, add the marketplace
/plugin marketplace add alirezarezvani/claude-skills/plugin install engineering@claude-code-skillsQuality Score
VerifiedTrust Signals
Similar Extensions
API Designer
99Use when designing REST or GraphQL APIs, creating OpenAPI specifications, or planning API architecture. Invoke for resource modeling, versioning strategies, pagination patterns, error handling standards.
Api Documenter
95API documentation specialist for OpenAPI/Swagger specifications. Use when documenting REST or GraphQL APIs.
Sdk Dx
100Design SDKs that developers love to use—APIs that feel native, error messages that guide, and experiences that reduce friction. This skill covers creating SDKs that drive adoption through exceptional developer experience rather than aggressive marketing. Trigger phrases: "SDK design", "developer experience", "API design", "SDK DX", "error messages", "type safety", "IDE integration", "SDK versioning", "migration guides", "client library design", "making SDKs feel native", "SDK best practices"
Api Design
99REST API design patterns including resource naming, status codes, pagination, filtering, error responses, versioning, and rate limiting for production APIs.
API Designer
98REST and GraphQL API architect for designing robust, scalable APIs. Use when designing new APIs or improving existing ones.
Aspnet Minimal Api Openapi
98Create ASP.NET Minimal API endpoints with proper OpenAPI documentation