skills.rest
cropsgg
cropsggCOMMUNITY
Explore all skills by this author →
GitHub

api-contract-validate

Detect contract drift between OpenAPI specifications and runtime implementations.

15|5|Updated May 17, 2026
Search Tags:#api#openapi#diff#contract-testing#contract#schema-drift
One-click install
npx skills add https://github.com/cropsgg/skills --skill api-contract-validate
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-contract-validate
Source: https://github.com/cropsgg/skills/tree/main/skills/engineering/api-contract-validate
Command: npx skills add https://github.com/cropsgg/skills --skill api-contract-validate

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Maintains alignment between OpenAPI schemas and runtime implementations to prevent silent contract drift.

Core Features & Use Cases

  • Contract-drift detection between OpenAPI specs and server/DTO implementations.
  • Enforces consistent error envelopes, nullable/optional field discipline, and stable pagination semantics.
  • Supports migration planning by producing clear change notes when breaking changes are necessary.

Quick Start

Run a contract-drift check across your services to verify that routes, schemas, and error handling align with the OpenAPI spec.

Frequently Asked Questions about api-contract-validate

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

FAQPage Schema
How do I detect OpenAPI contract drift between my spec and server implementations?▼

OpenAPI contract drift is detected by comparing your OpenAPI specifications against runtime server and DTO implementations to identify misaligned routes, schemas, and error handling.

What is the best way to enforce consistent error envelopes and nullable fields in API schemas?▼

Enforcing consistent error envelopes and nullable fields requires validating your API schemas to ensure optional field discipline and error response structures strictly align with your OpenAPI specifications.

How do I generate migration notes for breaking changes in OpenAPI, Protobuf, or GraphQL schemas?▼

Migration notes for breaking changes are generated by analyzing schema modifications across versioning and codegen updates, producing clear change documentation for client SDK generation and service updates.

Does contract testing work for microservices using GraphQL and Protobuf schemas?▼

Contract testing works for microservices using GraphQL and Protobuf schemas by validating pagination semantics and schema alignment across diverse API definitions and client SDK generation pipelines.

How do I validate pagination semantics and schema alignment across microservices?▼

Pagination semantics and schema alignment are validated by running contract-drift checks that verify routes, schemas, and error handling consistently match the defined OpenAPI specifications across services.

Related Skills

Explore More Software Engineering Skills→
rnavarychrnavarych
14

role-aqa:api-testing

Automate API testing for REST and GraphQL services with SuperTest, Pact, and OpenAPI.

Community
Advanced
gaebalaigaebalai
2

api-client-sdk-notes

Generate API client SDK release notes and migration guides from codebase changes, git logs, or OpenAPI specifications.

Community
Advanced
s3nex-coms3nex-com

api-contract-enforcer

Verify service implementations against OpenAPI specs using Pact or Schema Registry.

Community
Advanced
vladm3105vladm3105
16

contract-tester

Validate API contracts and detect breaking changes across OpenAPI/AsyncAPI specifications.

Community
Advanced