OpenAPI Spec Generator

Create robust, machine-readable API documentation using OpenAI Specification (OAS) v3.0 or v3.1.

When to Use This Skill

• Spec-First Development: Defining the API contract before writing code.
• Documentation: Generating openapi.yaml for existing REST APIs.
• Code Generation: creating Client SDKs (TypeScript/Python) from a spec.
• Validation: Ensure API implementation matches the design contract.

Core Concepts

1. Structure of OAS v3.1

A valid spec requires:

• Info: Title, Version, Description.
• Servers: Base URLs (Dev, Staging, Prod).
• Paths: Endpoints (/users, /login) and methods (GET, POST).
• Components: Reusable Schemas (Data Models), Responses, Security Schemes.