skills.rest
XSpoonAi
XSpoonAiOFFICIAL
Explore all skills by this author →
WebsiteGitHub

api-contract-diff

Compare OpenAPI and GraphQL schemas to produce categorized JSON diffs.

17|45|Updated Jan 23, 2026
Search Tags:#api#openapi#graphql#diff#ci-cd#schemas#changes
One-click install
npx skills add https://github.com/XSpoonAi/spoon-awesome-skill --skill api-contract-diff
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-contract-diff
Source: https://github.com/XSpoonAi/spoon-awesome-skill/tree/main/enterprise-skills/api-contract-diff
Command: npx skills add https://github.com/XSpoonAi/spoon-awesome-skill --skill api-contract-diff

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Managing API evolution is risky when schemas change. This Skill detects breaking and non-breaking changes between OpenAPI/Swagger specifications and GraphQL schemas, enabling teams to assess impact before deployment.

Core Features & Use Cases

  • Breaking Change Detection: Identify removed endpoints, methods, and incompatible changes.
  • Non-Breaking Changes Tracking: Flag additions and parameter updates that are backward-compatible.
  • Comprehensive Diff & Output: Compare full schemas and produce structured diffs suitable for CI/CD and changelogs.
  • Usage Scenarios: Validate changes during version upgrades, enforce compatibility, and document API evolution.

Quick Start

Run a quick demo or provide two schema objects to generate a diff.

Frequently Asked Questions about api-contract-diff

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

FAQPage Schema
How do I detect breaking API changes between OpenAPI and GraphQL schemas?▼

Detect breaking API changes by providing two OpenAPI or GraphQL schemas to generate a structured diff, which categorizes removed endpoints, methods, and incompatible parameter updates to assess deployment impact.

What is the best way to generate an API contract diff for CI/CD pipelines?▼

Generate an API contract diff for CI/CD by comparing two schema versions during pipeline execution to output a JSON-ready structured report categorizing breaking and non-breaking changes.

Can I track non-breaking changes like parameter additions in OpenAPI specifications?▼

Track non-breaking changes in OpenAPI specifications by comparing paths, methods, and parameters across schema versions to flag backward-compatible additions and output them in a structured JSON diff.

How do I compare two GraphQL schemas to find removed fields or endpoints?▼

Compare two GraphQL schemas by running a structured diff process that evaluates structural changes, reports removed fields and endpoints, and outputs categorized results for API evolution reviews.

Does API contract diffing output structured data for automated changelog generation?▼

API contract diffing outputs a JSON-ready structured diff categorizing breaking and non-breaking changes, making it directly suitable for automated changelog generation and CI/CD workflow validation.

Related Skills

Explore More Software Engineering Skills→
belokonmbelokonm
8

api-documenter

Generate OpenAPI/Swagger specifications and GraphQL schema documentation for RESTful APIs.

Community
Advanced
mehdicmehdic

api-contract-validation

Analyzes OpenAPI specs and detects breaking changes to prevent them.

Community
Advanced
thanh-abaiithanh-abaii
34

gs:land-and-deploy

Merge pull requests, run CI/CD pipelines, and verify production health.

Community
Advanced
VIethoangnguyenleVIethoangnguyenle

review

Analyze code diffs and pull requests for safety and structural issues.

Community
Intermediate