The API Design Reviewer skill provides comprehensive analysis and review of API designs, focusing on REST conventions, best practices, and industry standards. This skill helps engineering teams build consistent, maintainable, and well-designed APIs through automated linting, breaking change detection, and design scorecards.
Core Capabilities
1. API Linting and Convention Analysis
Resource Naming Conventions
Enforces kebab-case for resources, camelCase for fields
HTTP Method Usage
Validates proper use of GET, POST, PUT, PATCH, DELETE
URL Structure
Analyzes endpoint patterns for consistency and RESTful design
Status Code Compliance
Ensures appropriate HTTP status codes are used
Error Response Formats
Validates consistent error response structures
Documentation Coverage
Checks for missing descriptions and documentation gaps
Show more