skill by

Openapi Spec Generation

Generate and maintain OpenAPI 3.1 specifications from code, design-first specs, and validation patterns. Use when creating API documentation, generating SDKs, or ensuring API contract compliance.

Add skill

Follow @wshobson

Permissions

Files

SKILL.md

openapi-spec-generation

Generate and maintain OpenAPI 3.1 specifications from code, design-first specs, and validation patterns. Use when creating API documentation, generating SDKs, or ensuring API contract compliance.

OpenAPI Spec Generation

Comprehensive patterns for creating, maintaining, and validating OpenAPI 3.1 specifications for RESTful APIs.

When to Use This Skill

Creating API documentation from scratch
Generating OpenAPI specs from existing code
Designing API contracts (design-first approach)
Validating API implementations against specs
Generating client SDKs from specs
Setting up API documentation portals

Core Concepts

1. OpenAPI 3.1 Structure

openapi: 3.1.0
info:

3 files · 25 KB2 KB

Install

It’s free, and every skill you add syncs into every AI tool on your computer, instantly.

Get the Skillet appor

npx skilletmd add @wshobson/openapi-spec-generation -y

Version history

Approach	Description	Best For
Design-First	Write spec before code	New APIs, contracts
Code-First	Generate spec from code	Existing APIs
Hybrid	Annotate code, generate spec	Evolving APIs

Openapi Spec Generation

OpenAPI Spec Generation

When to Use This Skill

Core Concepts

1. OpenAPI 3.1 Structure

2. Design Approaches

Templates and detailed worked examples

Best Practices

Do's

Don'ts