contract

Generate and validate OpenAPI 3.1 and AsyncAPI 2.6 API contracts.

Updated Mar 7, 2026
One-click install
npx skills add https://github.com/MassimilianoPili/agent-framework --skill contract
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: contract
Source: https://github.com/MassimilianoPili/agent-framework/tree/main/.claude/agents/contract
Command: npx skills add https://github.com/MassimilianoPili/agent-framework --skill contract

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill automates the creation and validation of API contracts, ensuring consistency and adherence to standards in your development process.

Core Features & Use Cases

  • Contract-First Development: Design and generate OpenAPI 3.1 specifications before implementation.
  • Schema Definition: Define resources, operations, schemas, and error responses according to RESTful principles.
  • Use Case: When starting a new microservice, use this Skill to generate the OpenAPI specification for its REST endpoints, serving as the definitive contract for frontend and backend teams.

Quick Start

Use the contract skill to create an OpenAPI 3.1 specification for a new User Management API.

Frequently Asked Questions about contract

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

FAQPage Schema
How do I generate an OpenAPI specification for a new REST API?

To generate an OpenAPI specification, use contract-first development principles to define resources, operations, schemas, and error responses before implementation. This ensures consistency and adherence to standards in your RESTful API development process.

What is contract-first API development and when should I use it?

Contract-first API development involves designing and generating OpenAPI 3.1 or AsyncAPI 2.6 specifications before writing any implementation code. Use it when starting a new microservice to establish a definitive contract for frontend and backend teams.

Can I define pagination, filtering, and error responses in an OpenAPI schema?

Yes, you can define pagination, filtering, and comprehensive error responses directly within your OpenAPI schema. This enforces RESTful resource design principles and standardizes API behavior across your services.

How do I validate an API contract against OpenAPI standards?

You validate an API contract by integrating with linting tools that check your OpenAPI 3.1 and AsyncAPI 2.6 specifications. This validation ensures your schema definitions adhere to semantic versioning and required standards.

Does contract-first development support AsyncAPI specifications?

Yes, contract-first development supports AsyncAPI 2.6 specifications alongside OpenAPI 3.1. You can define and validate event-driven API contracts using the same principles as RESTful resource design.

Why should I design API schemas before implementing backend code?

Designing API schemas before implementation ensures consistency and adherence to standards across your development process. It provides a definitive contract for frontend and backend teams, preventing integration issues when starting new microservices.