Marketplace

generating-api-contracts

Generate API contracts and OpenAPI specifications from code or design documents. Use when documenting API contracts and specifications. Trigger with phrases like "generate API contract", "create OpenAPI spec", or "document API contract".

allowed_tools: Read, Write, Edit, Grep, Glob, Bash(api:contract-*)

$ 설치

git clone https://github.com/jeremylongshore/claude-code-plugins-plus-skills /tmp/claude-code-plugins-plus-skills && cp -r /tmp/claude-code-plugins-plus-skills/plugins/api-development/api-contract-generator/skills/generating-api-contracts ~/.claude/skills/claude-code-plugins-plus-skills

// tip: Run this command in your terminal to install the skill

SKILL.md

View on GitHub →

name: generating-api-contracts description: | Generate API contracts and OpenAPI specifications from code or design documents. Use when documenting API contracts and specifications. Trigger with phrases like "generate API contract", "create OpenAPI spec", or "document API contract".

allowed-tools: Read, Write, Edit, Grep, Glob, Bash(api:contract-*) version: 1.0.0 author: Jeremy Longshore jeremy@intentsolutions.io license: MIT

Generating Api Contracts

Overview

This skill provides automated assistance for api contract generator tasks. This skill provides automated assistance for the described functionality.

Prerequisites

Before using this skill, ensure you have:

API design specifications or requirements documented
Development environment with necessary frameworks installed
Database or backend services accessible for integration
Authentication and authorization strategies defined
Testing tools and environments configured

Instructions

Use Read tool to examine existing API specifications from {baseDir}/api-specs/
Define resource models, endpoints, and HTTP methods
Document request/response schemas and data types
Identify authentication and authorization requirements
Plan error handling and validation strategies
Generate boilerplate code using Bash(api:contract-*) with framework scaffolding
Implement endpoint handlers with business logic
Add input validation and schema enforcement
Integrate authentication and authorization middleware
Configure database connections and ORM models
Write integration tests covering all endpoints

See {baseDir}/references/implementation.md for detailed implementation guide.

Output

{baseDir}/src/routes/ - Endpoint route definitions
{baseDir}/src/controllers/ - Business logic handlers
{baseDir}/src/models/ - Data models and schemas
{baseDir}/src/middleware/ - Authentication, validation, logging
{baseDir}/src/config/ - Configuration and environment variables
OpenAPI 3.0 specification with complete endpoint definitions

Error Handling

See {baseDir}/references/errors.md for comprehensive error handling.

Examples

See {baseDir}/references/examples.md for detailed examples.

Resources

Express.js and Fastify for Node.js APIs
Flask and FastAPI for Python APIs
Spring Boot for Java APIs
Gin and Echo for Go APIs
OpenAPI Specification 3.0+ for API documentation