What API formats can this skill generate?

The skill supports OpenAPI 3.1 for RESTful APIs, AsyncAPI 3.0 for event-driven systems, and Protocol Buffers (proto3) for gRPC services.

Does it include security definitions?

Yes, the skill can generate authentication configurations such as JWT, OAuth2, and other common security schemes within the contract.

Can I use this for existing legacy systems?

While designed for contract-first development, you can describe an existing system's behavior to generate a retrospective specification for documentation purposes.

Does the skill decide which API format to use automatically?

Yes, if a format is not explicitly specified, the skill analyzes your requirements to recommend the most appropriate standard based on your communication patterns.

API Contract Generator

Name: API Contract Generator
Author: melodic-software

bymelodic-software

•

API開発

Generates standardized API specifications including OpenAPI, AsyncAPI, and Protocol Buffers from natural language requirements.

The API Contract skill facilitates contract-first development by transforming domain requirements and high-level descriptions into industry-standard specifications. It intelligently detects the optimal protocol based on the provided context—be it RESTful endpoints via OpenAPI 3.1, event-driven messaging via AsyncAPI 3.0, or high-performance RPC via Protocol Buffers. By automating the boilerplate of schema definitions, operation mappings, and security configurations, this skill ensures consistency across microservices and accelerates the initial design phase of the software development lifecycle.

主な機能

01Multi-format support for OpenAPI 3.1, AsyncAPI 3.0, and Protocol Buffers

02Generates implementation notes and suggested contract test scenarios

03Intelligent auto-detection of API patterns from natural language descriptions

0438 GitHub stars

05Comprehensive schema definition including entities, relationships, and enumerations

06Automated configuration of authentication and security schemes

ユースケース

01Defining high-performance gRPC service interfaces for internal microservice communication

02Bootstrapping a new RESTful microservice with a standards-compliant OpenAPI specification

03Designing event-driven architectures for message brokers like Kafka using AsyncAPI

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add melodic-software/claude-code-plugins api-contract

For use in Claude.ai and ChatGPT

Download Skill