regression-api-contract

Detect breaking changes in REST, GraphQL, and gRPC API contracts.

175|26|Updated Aug 14, 2025
One-click install
npx skills add https://github.com/jmagly/aiwg --skill regression-api-contract-jmagly
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: regression-api-contract
Source: https://github.com/jmagly/aiwg/tree/main/plugins/sdlc/skills/regression-api-contract
Command: npx skills add https://github.com/jmagly/aiwg --skill regression-api-contract-jmagly

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

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.

Frequently Asked Questions about regression-api-contract

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I detect breaking changes in a REST API before deployment?

Detect breaking changes in a REST API by comparing current OpenAPI definitions against a baseline to identify modifications that break backward compatibility. This process validates semantic versioning compliance and highlights regressions before microservice deployment.

Does consumer contract testing work with GraphQL schema changes?

Consumer contract testing works with GraphQL schema changes by comparing current schemas against baselines to catch breaking modifications. It integrates with tools like Pact to assess consumer impact and validate backward compatibility automatically.

What is the best way to enforce semantic versioning across gRPC and protobuf definitions?

Enforce semantic versioning across gRPC and protobuf definitions by comparing current contracts against baselines to detect breaking changes. This validates that version bumps correctly align with the severity of modifications found in the API definitions.

Can I use Pact to assess the impact of API breaking changes?

You can use Pact to assess the impact of API breaking changes by integrating consumer contract testing with baseline comparisons. This verifies whether modifications to REST, GraphQL, or gRPC interfaces break existing consumers before deployment.

How do I check for backward compatibility in a microservice API?

Check for backward compatibility in a microservice API by comparing current interface definitions against a baseline to detect breaking changes. This validates semantic versioning and integrates with Spring Cloud Contract to ensure no existing consumers are broken.