api-design-reviewer

Solid

API Design Reviewer

AI & Automation 16,392 stars 2261 forks Updated today MIT

Install

View on GitHub

Quality Score: 92/100

Stars 20%
100
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# API Design Reviewer **Tier:** POWERFUL **Category:** Engineering / Architecture **Maintainer:** Claude Skills Team ## Overview 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 ### 2. Breaking Change Detection - **Endpoint Removal**: Detects removed or deprecated endpoints - **Response Shape Changes**: Identifies modifications to response structures - **Field Removal**: Tracks removed or renamed fields in API responses - **Type Changes**: Catches field type modifications that could break clients - **Required Field Additions**: Flags new required fields that could break existing integrations - **Status Code Changes**: Detects changes to expected s...

Details

Author
alirezarezvani
Repository
alirezarezvani/claude-skills
Created
7 months ago
Last Updated
today
Language
Python
License
MIT

Integrates with

Related Skills