qa-api-contract-curator

Generate OpenAPI 3.x specifications and detect breaking changes from API sources.

2|2|Updated Mar 7, 2026
One-click install
npx skills add https://github.com/AZANIR/qa-skills --skill qa-api-contract-curator
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: qa-api-contract-curator
Source: https://github.com/AZANIR/qa-skills/tree/main/.cursor/skills/qa-api-contract-curator
Command: npx skills add https://github.com/AZANIR/qa-skills --skill qa-api-contract-curator

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill streamlines the management of API contracts by formalizing them into OpenAPI specifications, detecting breaking changes, and ensuring consistency across API versions.

Core Features & Use Cases

  • OpenAPI Specification Generation: Create or update OpenAPI 3.x specs from various sources (endpoints, HAR files, developer input).
  • Breaking Change Detection: Automatically identify and report backward-incompatible changes between API versions.
  • Use Case: Before releasing a new version of your API, use this Skill to generate an OpenAPI spec and compare it against the previous version to proactively identify any breaking changes that could impact consumers.

Quick Start

Use the qa-api-contract-curator skill to generate an OpenAPI 3.x specification from the provided HAR file.

Frequently Asked Questions about qa-api-contract-curator

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

FAQPage Schema
How do I detect breaking changes in an OpenAPI specification between API versions?

To detect breaking changes in an OpenAPI specification, you can process your existing endpoints and OpenAPI files to automatically identify and report backward-incompatible modifications between API versions. This ensures consistency and prevents consumer impact during API versioning.

Can I generate an OpenAPI 3.x spec from a HAR file or network traffic capture?

Yes, you can generate an OpenAPI 3.x spec from a HAR file or network traffic capture. The system processes input from existing endpoints, developer interviews, and codebase analysis to produce a single, validated, and version-controlled API contract.

What is API contract management and when do I need to formalize it?

API contract management is the process of formalizing API interactions into validated OpenAPI specifications. You need to formalize API contracts when you want to ensure consistency across API versions and proactively manage backward compatibility before releasing updates.

How do I create versioning rules for an API contract?

You can create versioning rules for an API contract by analyzing existing endpoints, Swagger files, and codebase structures. The system generates version-controlled rules and validates the OpenAPI specification to maintain backward compatibility across releases.

Does this approach work with Swagger files and existing codebase analysis?

Yes, this approach works with Swagger files and existing codebase analysis. It processes input from existing endpoints, network traffic captures, and developer interviews to consolidate everything into a single, validated OpenAPI specification.

What is the best way to formalize API endpoints into a version-controlled contract?

The best way to formalize API endpoints into a version-controlled contract is to aggregate inputs from Swagger files, network traffic, and codebase analysis. This generates a single validated OpenAPI specification while automatically detecting backward-incompatible breaking changes.