How does the skill detect breaking changes?

It compares different versions of an API specification to identify field removals, type changes, or endpoint deletions that could disrupt existing clients.

Can this skill be used in CI/CD pipelines?

Yes, the skill includes integration scripts like api_linter.py that can be triggered within GitHub Actions or other CI/CD workflows.

What standards does the design reviewer follow?

It enforces standard REST conventions, including kebab-case resource naming, proper HTTP method usage, and consistent error response structures.

Does it support OpenAPI and Swagger?

Yes, the tools are designed to validate and analyze OpenAPI/Swagger specifications to ensure they meet modern industry standards.

API Design Reviewer

Name: API Design Reviewer
Author: oabdelmaksoud

byoabdelmaksoud

0•

API 开发

Automates the review of API designs to ensure RESTful compliance, detect breaking changes, and improve architectural consistency.

The API Design Reviewer skill empowers engineering teams to build high-quality, maintainable REST APIs by providing automated analysis against industry best practices. It serves as an architectural guardian within the Claude Code environment, performing deep linting for resource naming and HTTP usage, identifying potential breaking changes before they reach production, and providing a comprehensive design scorecard. Whether you are drafting a new OpenAPI specification or evolving an existing service, this skill ensures your API remains secure, performant, and developer-friendly.

主要功能

01Detailed documentation coverage and error response validation

02Automated REST API linting and naming convention enforcement

030 GitHub stars

04Proactive breaking change detection for endpoints and schemas

05CI/CD integration scripts for automated API quality gates

06Comprehensive design scoring based on security, usability, and performance

使用场景

01Generating a quality scorecard for legacy APIs to prioritize refactoring

02Detecting breaking changes during the PR review process between API versions

03Reviewing a new OpenAPI/Swagger specification for architectural consistency

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add oabdelmaksoud/agention api-design-reviewer

For use in Claude.ai and ChatGPT

主要功能

01Detailed documentation coverage and error response validation

02Automated REST API linting and naming convention enforcement

030 GitHub stars

04Proactive breaking change detection for endpoints and schemas

05CI/CD integration scripts for automated API quality gates

06Comprehensive design scoring based on security, usability, and performance

使用场景

01Generating a quality scorecard for legacy APIs to prioritize refactoring

02Detecting breaking changes during the PR review process between API versions

03Reviewing a new OpenAPI/Swagger specification for architectural consistency

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add oabdelmaksoud/agention api-design-reviewer

For use in Claude.ai and ChatGPT