skills.rest
robwestz
robwestzCOMMUNITY
Explore all skills by this author →
GitHub

api-contract-review

Review API contracts for completeness, consistency, and breaking changes.

Updated Apr 9, 2026
Search Tags:#api#openapi#audit#breaking changes#review#swagger
One-click install
npx skills add https://github.com/robwestz/memoryporter --skill api-contract-review-robwestz
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-contract-review
Source: https://github.com/robwestz/memoryporter/tree/main/knowledge/meta-skills/skill-forge/examples/standard-example
Command: npx skills add https://github.com/robwestz/memoryporter --skill api-contract-review-robwestz

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill addresses the challenge of ensuring API contracts meet high standards of completeness, consistency, and risk mitigation before deployment.

Core Features & Use Cases

  • Comprehensive Review: Audits OpenAPI/Swagger specs, GraphQL schemas, or REST endpoint documentation.
  • Consistency Checks: Catches naming inconsistencies, missing error schemas, and undocumented auth.
  • Breaking Change Detection: Identifies breaking changes between API versions.
  • Use Case: Before releasing a new API version, use this Skill to ensure it's ready for production.

Quick Start

Use the 'api-contract-review' skill to review the API specification 'api-spec.yaml'.

Frequently Asked Questions about api-contract-review

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

FAQPage Schema
How do I detect breaking changes between OpenAPI or Swagger versions?▼

Audit GraphQL schemas for completeness and consistency by reviewing the schema definitions against API contract standards. This catches missing error schemas and naming inconsistencies before release.

What is the best way to review an API contract for missing fields and inconsistent naming?▼

Reviewing an API contract systematically checks your OpenAPI, Swagger, GraphQL, or REST documentation for missing fields and inconsistent naming. This ensures your API specifications meet high quality and compliance standards before deployment.

Can I use an automated audit for REST endpoint documentation before release?▼

Yes, you can audit REST endpoint documentation before release to ensure production readiness. The review process checks endpoint documentation for completeness, consistency, and compliance across your specified API formats.

Does API contract review work with both OpenAPI and GraphQL formats?▼

API contract review works with OpenAPI, Swagger, GraphQL, and REST formats. It systematically audits these API specifications to detect undocumented auth, missing error schemas, and breaking changes between versions.

Why should I run a pre-release audit on my API specification?▼

Run a pre-release audit on your API specification to mitigate deployment risks and ensure completeness. This review catches breaking changes, missing fields, and inconsistent naming before the API reaches production.

Related Skills

Explore More Software Engineering Skills→
jhlee0409jhlee0409
4

openapi-parser

Parse OpenAPI 3.x and Swagger 2.0 specs into structured endpoint catalogs.

Community
Advanced
Harshal1841AHarshal1841A

api-design-reviewer

Analyze OpenAPI specifications to detect design inconsistencies, security issues, and breaking changes.

Community
Advanced
mikopbxmikopbx
569

openapi-analyzer

Extract and analyze OpenAPI 3.1.0 specifications to validate endpoints and generate tests.

Official
Advanced
no-problem-devno-problem-dev
5

go-quality

Run golangci-lint static analysis and generate OpenAPI specs with swag.

Official
Intermediate