What naming conventions does the reviewer enforce?

By default, it promotes RESTful best practices such as kebab-case for resource URLs, camelCase for JSON fields, and the use of nouns instead of verbs in endpoint paths.

Can I integrate this into my existing workflow?

Yes, the skill is designed to work within Claude Code and includes scripts that can be integrated into CI/CD pipelines or local pre-commit hooks for automated validation.

How does the skill detect breaking changes?

The skill compares different versions of OpenAPI/Swagger specifications to identify removed fields, modified data types, renamed endpoints, or new required parameters that would break existing client integrations.

Does it provide security recommendations?

Yes, the reviewer assesses authentication patterns (like OAuth 2.0 and Bearer tokens), checks for authorization controls, and validates the implementation of security headers and rate limiting.

API Design Reviewer

Name: API Design Reviewer
Author: borghei

byborghei

•

API開発

Reviews and optimizes REST API designs by linting OpenAPI specifications, detecting breaking changes, and generating quality scorecards based on industry best practices.

The API Design Reviewer is a comprehensive engineering skill designed to standardize and improve the quality of RESTful APIs. It automates the tedious process of reviewing API contracts for consistency in naming conventions, HTTP method usage, and URL structures while providing critical safeguards like breaking change detection between versions. By analyzing OpenAPI and Swagger specifications, this skill provides actionable insights through multi-dimensional scorecards covering security, performance, and usability, ensuring your interfaces remain maintainable, backward-compatible, and developer-friendly throughout their lifecycle.

主な機能

01Enforcement of standardized resource naming and consistent error response formats

0250 GitHub stars

03Automated breaking change detection to prevent integration failures between versions

04Validation of versioning strategies, pagination patterns, and idempotency

05Comprehensive API quality scorecards across security, usability, and performance

06OpenAPI and Swagger specification linting for RESTful convention compliance

ユースケース

01Running automated regression checks in CI/CD pipelines to catch breaking schema changes

02Validating new API endpoints during the design phase to ensure architectural consistency

03Auditing legacy APIs to identify security gaps and improve developer experience

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add borghei/claude-skills api-design-reviewer

For use in Claude.ai and ChatGPT

Download Skill