skills sourced live from GitHub · all skills listed are free · each skill is provided under its author's license.
home / API & Integrations / API Design Reviewer Skill by @alirezarezvani
The skill is the engineering/skills/api-design-reviewer folder inside that repository. Copy it into the folder your agent loads skills from; check your agent's documentation for where that is.
Use for any PR or spec that adds or changes REST endpoints, before approving it.
Reviews pull requests or specs that add or change REST endpoints. It lints conventions, detects breaking changes and scores the design using bundled scripts.
The original SKILL.md is organised into these sections:
Written and maintained by @alirezarezvani. It is published under the MIT license, which allows reuse with attribution. See the author profile. SkillDirectory does not claim authorship: this page adds our own review and links back to the original, and the skill's text belongs to its author.
# 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. ## Quick Start — run the tools first ```bash # 1. Lint an OpenAPI/Swagger spec for convention violations python3 scripts/api_linter.py openapi.json --format json -o lint.json # 2. Detect breaking changes between two spec versions (gate: exits non-zero with --exit-on-breaking) python3 scripts/breaking_change_detector.py openapi-v1.json openapi-v2.json --format json --exit-on-breaking -o breaking.json # 3. Score overall design quality (gate: --min-grade fails below threshold) …
Excerpt only, quoted from the author's repository. Open the repository for the complete file.