🛡️OpenAPI Contract Guard

What it does

OpenAPI Contract Guard is a specialized developer tool designed to catch breaking changes and linting violations in your API specifications before they reach production. It analyzes OpenAPI and Swagger files to identify risks that could impact downstream consumers, such as removed endpoints, modified property types, or missing documentation.

Why use this skill

Manual API reviews are error-prone and time-consuming. This skill automates the detection of "silent breakages" that simple linters often miss. It provides a structured heuristic analysis of the differences between two versions of a spec, ensuring your team maintains strict backward compatibility. By integrating this into your workflow, you prevent broken client integrations and reduce the overhead of manual contract testing.

• Automated Breaking Change Detection: Instantly identifies removals or modifications of existing endpoints and fields.
• Comprehensive Linting: Surfaces style and structural issues following best practices.
• Remediation Guidance: Every finding includes technical evidence and specific steps to fix the issue.
• Format Agnostic: While the core scanner processes JSON, the skill handles YAML-to-JSON conversion seamlessly.

Supported tools

Supports OpenAPI 3.x and Swagger 2.0 specifications in both JSON and YAML formats. It uses a custom Python-based heuristic engine for deep diff analysis.