skills.rest
ybbms777
ybbms777COMMUNITY
Explore all skills by this author →
GitHub

api-contract-reviewer

Detect breaking changes in public API interfaces during code review.

1|Updated Apr 4, 2026
Search Tags:#versioning#type-safety#breaking-changes#code-review#api-contract#backend-development#api-stability
One-click install
npx skills add https://github.com/ybbms777/compound-engineering --skill api-contract-reviewer-ybbms777
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-contract-reviewer
Source: https://github.com/ybbms777/compound-engineering/tree/main/skills/agent-api-contract-reviewer
Command: npx skills add https://github.com/ybbms777/compound-engineering --skill api-contract-reviewer-ybbms777

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill eliminates the risk of undetected breaking API changes that cause client integration failures, silent data errors, and production outages when old client versions interact with updated server interfaces.

Core Features & Use Cases

  • Breaking Change Detection: Identifies renamed fields, removed endpoints, altered response shapes, narrowed input types, and changed status codes that break existing client integrations, classifying changes as additive (safe) or subtractive/mutative (breaking).
  • Versioning Compliance Checks: Flags breaking changes shipped without version bumps, deprecation periods, or clear migration paths that would leave old clients with incorrect data or unhandled errors.
  • Use Case: For example, when a developer modifies a public user API endpoint to remove a previously required user_id field from the response, this Skill automatically flags that all existing mobile app clients relying on that field will crash after deployment.

Quick Start

Use the api-contract-reviewer skill to evaluate the latest code diff for any breaking API contract changes that would impact existing client integrations.

Frequently Asked Questions about api-contract-reviewer

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

FAQPage Schema
How do I detect breaking API contract changes before deployment?▼

To detect breaking API contract changes, review code diffs for renamed fields, removed endpoints, altered response shapes, and narrowed input types. This process classifies modifications as additive (safe) or subtractive (breaking) to prevent client integration failures.

What is an unversioned breaking API change?▼

An unversioned breaking API change is a backward-incompatible modification shipped without a version bump or deprecation period. It causes silent data errors and production outages when old client versions interact with updated server interfaces.

How do I check API versioning compliance in code review?▼

Check API versioning compliance by flagging breaking changes shipped without version bumps, deprecation periods, or clear migration paths. Validate that altered status codes and response shapes include proper versioning to protect existing client integrations.

Does this API contract review work with backend type signature updates?▼

Yes, API contract review works with backend type signature updates. It evaluates exported type adjustments, serialization logic changes, and narrowed input types to validate contract stability and prevent backward-incompatible type modifications.

What causes client integration failures after API updates?▼

Client integration failures after API updates are caused by undocumented behavior shifts, removed API endpoints, and altered response shapes. These subtractive changes leave old clients with incorrect data or unhandled errors during production interactions.

When should I not use automated breaking change detection?▼

You should not use automated breaking change detection when implementing purely additive API features or internal backend modifications. The process targets public API interfaces, so changes to private routes or safe additive fields do not require contract stability validation.

Related Skills

Explore More Software Engineering Skills→
rsicarellirsicarelli
63

kotlin-api-consultant

Query Kotlin compiler source code to detect breaking API changes.

Community
Advanced
robotijnrobotijn
3

backwards-compatibility-checker

Detect breaking changes across APIs and enforce semantic versioning compliance.

Community
Advanced
alti3alti3
7

litestar-custom-types

Register decoders and encoders for custom domain types in Litestar.

Community
Advanced
eng-vmessiaheng-vmessiah
2

ai-regression-testing

Automate regression tests validating API response shapes and state integrity.

Community
Intermediate