Skip to content

api-design-reviewer

Comprehensive REST API design review with automated linting, breaking-change detection, and design scorecards. Catches inconsistent conventions, missing versioning, and design smells before APIs ship. Use when reviewing a PR that adds or changes API endpoints, auditing an existing API for v2 migration, or establishing API standards for a team.

Repository Source folder

Details

Path
engineering/skills/api-design-reviewer
License
MIT
Bundled scripts
3

Bundled scripts

  • engineering/skills/api-design-reviewer/scripts/breaking_change_detector.py
  • engineering/skills/api-design-reviewer/scripts/api_linter.py
  • engineering/skills/api-design-reviewer/scripts/api_scorecard.py

FAQ