What problem does it solve?
This Skill automatically detects breaking changes in API contracts across various protocols like REST, GraphQL, and gRPC, preventing unexpected regressions and ensuring backward compatibility.
Core Features & Use Cases
- Comprehensive API Analysis: Analyzes OpenAPI, GraphQL schemas, and Protobuf definitions.
- Automated Regression Detection: Identifies removed endpoints, fields, type changes, and other breaking modifications.
- Semantic Versioning Enforcement: Validates that version bumps align with the severity of changes.
- Consumer Impact Assessment: Integrates with consumer contract testing (Pact, Spring Cloud Contract) to highlight affected consumers.
- Use Case: Before deploying a new version of your core API, use this Skill to automatically scan for any changes that could break existing client applications, providing a detailed report and blocking deployment if critical regressions are found.
Quick Start
Run a check for API breaking changes using the provided OpenAPI specification files.