What problem does it solve?
This Skill automatically detects breaking changes in API contracts across various protocols (REST, GraphQL, gRPC), ensuring backward compatibility and preventing unexpected regressions.
Core Features & Use Cases
- Automated Contract Comparison: Compares current API definitions against baselines to identify breaking modifications.
- Multi-Protocol Support: Handles OpenAPI (REST), GraphQL schemas, and gRPC/protobuf definitions.
- Consumer Impact Analysis: Integrates with consumer contract testing (Pact, Spring Cloud Contract) to assess the real-world impact of changes.
- Semantic Versioning Enforcement: Validates that version bumps align with the severity of detected changes.
- Use Case: Before deploying a new version of your microservice API, run this Skill to automatically verify that no existing consumers will be broken by the changes, and that the versioning is correctly applied.
Quick Start
Use the regression-api-contract skill to check for breaking changes in the current API against the v1 baseline.