api-contract

Reconcile backend and frontend LLDs into a unified OpenAPI contract.

3|Updated Jul 1, 2026
One-click install
npx skills add https://github.com/KeyValueSoftwareSystems/maestro --skill api-contract-keyvaluesoftwaresystems
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-contract
Source: https://github.com/KeyValueSoftwareSystems/maestro/tree/main/skills/core/sdlc/api-contract
Command: npx skills add https://github.com/KeyValueSoftwareSystems/maestro --skill api-contract-keyvaluesoftwaresystems

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill eliminates integration friction between frontend and backend teams by reconciling disparate Low-Level Designs (LLDs) into a single, authoritative OpenAPI contract.

Core Features & Use Cases

  • Automated Reconciliation: Compares backend-exposed and frontend-consumed API definitions to identify mismatches in shape, pagination, or error handling.
  • Standardized Documentation: Generates precise OpenAPI specifications including auth, validation, and idempotency requirements.
  • Use Case: When a backend team updates an endpoint, this skill ensures the frontend team's consumption requirements are met, preventing breaking changes before implementation begins.

Quick Start

Use the api-contract skill to reconcile the backend and frontend LLDs located in the current directory and write the resulting OpenAPI specification to the docs folder.

Frequently Asked Questions about api-contract

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

FAQPage Schema
How do I reconcile frontend and backend API designs into a single OpenAPI contract?

To reconcile frontend and backend API designs, compare the disparate Low-Level Designs (LLDs) from both teams to identify mismatches in shape, pagination, or error handling, generating a unified OpenAPI specification.

What is the best way to prevent breaking changes in cross-repo API development?

Preventing breaking changes in cross-repo API development requires defining strict API boundaries and acceptance criteria by reconciling backend-exposed and frontend-consumed definitions into an authoritative OpenAPI contract before implementation begins.

How does automated API contract reconciliation handle error shapes and auth schemes?

Automated API contract reconciliation flags mismatches in error shapes and auth schemes by comparing LLDs, but it requires manual verification to ensure strict adherence to OpenAPI standards and accurate pagination logic.

When do I need to generate a unified OpenAPI specification for distributed software teams?

You need to generate a unified OpenAPI specification when integration friction arises between distributed frontend and backend teams, ensuring cross-repo architectural alignment by defining idempotency requirements and validation constraints.

Can I use low-level designs to automatically generate OpenAPI documentation with auth and validation requirements?

Yes, you can use low-level designs to generate standardized OpenAPI documentation by comparing the backend and frontend definitions to produce precise specifications including auth, validation, and idempotency requirements.

What are the limitations of using low-level designs for API contract reconciliation?

The limitation of using low-level designs for API contract reconciliation is that while it identifies mismatches automatically, it requires manual verification of error shapes, auth schemes, and pagination logic to guarantee strict OpenAPI adherence.