api-design-reviewer

OpenAPI spec breaking changes are detected by comparing versions to identify endpoint removals, schema modifications, and added required fields. The breaking_change_detector.py component automates this comparison to prevent backward compatibility issues.

REST API linting validates OpenAPI documents against conventions for resource naming, HTTP methods, URL structures, status codes, and error formats. The api_linter.py component enforces these design rules to ensure API conformance and documentation coverage.

An API design scorecard assesses REST APIs using multi-dimensional metrics to guide improvements and maintain consistency. The api_scorecard.py component evaluates OpenAPI specs to generate a quantitative design score across various REST principles.

API linting and breaking-change detection can be integrated into CI/CD pipelines and pre-commit hooks. The Skill provides examples showcasing how to run api_linter.py, breaking_change_detector.py, and api_scorecard.py automatically during development workflows.

The API design reviewer checks pagination patterns and error response formats as part of its REST design conformance checks. It standardizes API design by validating these structures against industry principles within OpenAPI specifications.