api-design-reviewer

Topics in the source

• API Design Reviewer
• Overview
• Quick Start — run the tools first
• Core Capabilities
• 1. API Linting and Convention Analysis
• 2. Breaking Change Detection
• 3. API Design Scoring and Assessment
• REST Design Principles

Tier: POWERFUL Category: Engineering / Architecture Maintainer: Claude Skills Team 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. Review flow: run all three, report linter findings + breaking changes + grade to the user, fix, then re-run until the linter is clean, --exit-on-breaking passes (or breaking changes are version-bumped), and the scorecard meets the agreed --min-grade. Never sign off an API review on prose alone — attach the tool outputs. 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 Endpoint Remo

This is an excerpt. Refer to the complete source and its current requirements.