api-contract-validation
Detect breaking changes in API contracts (OpenAPI/Swagger specs)
Security Assessment
About api-contract-validation
The api-contract-validation skill is designed to help developers and teams detect breaking changes in API contracts, specifically for OpenAPI/Swagger specifications. This tool ensures that changes to API endpoints, request/response schemas, or documentation are backward-compatible, preventing issues that could disrupt client applications. By identifying breaking changes early, it helps teams maintain compatibility and avoid costly bugs or disruptions in production environments.
FAQ
When should I use this skill?
You should use this skill when making changes to API endpoints, modifying request or response schemas, reviewing API PRs, before deploying updates, or in a CI/CD pipeline for API projects.
What are the main requirements for using this skill?
The skill requires an existing OpenAPI/Swagger spec and access to the baseline (previous API version) for comparison. It cannot be used for non-REST APIs or APIs without external clients.
What happens if no breaking changes are detected?
If no breaking changes are detected, the skill will report all changes as safe and backward-compatible, listing the new additions or modifications made to the API.
What happens if no API contract is found?
If no API specification is found, the skill will indicate that no contract is available for validation and will not perform any checks.
Is this skill compatible with all types of APIs?
This skill is specifically designed for REST APIs with OpenAPI/Swagger specifications. It is not compatible with GraphQL, gRPC, or other non-REST API types.
Install api-contract-validation
Quick Setup:
- Copy the skill folder to
.claude/skills/ - Claude will automatically detect and use the skill
Repository
mehdic/bazinga