Comprehensive patterns for creating, maintaining, and validating OpenAPI 3.1 specifications for RESTful APIs.
Use this skill when
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
Do not use this skill when
The task is unrelated to openapi spec generation
You need a different domain or tool outside this scope
Instructions
Clarify goals, constraints, and required inputs.
Apply relevant best practices and validate outcomes.
Provide actionable steps and verification.
If detailed examples are required, open resources/implementation-playbook.md.
Resources
resources/implementation-playbook.md for detailed patterns and examples.
1---2name: openapi-spec-generation3description: OpenAPI Spec Generation4---5# OpenAPI Spec Generation67Comprehensive patterns for creating, maintaining, and validating OpenAPI 3.1 specifications for RESTful APIs.89## Use this skill when1011- Creating API documentation from scratch12- Generating OpenAPI specs from existing code13- Designing API contracts (design-first approach)14- Validating API implementations against specs15- Generating client SDKs from specs16- Setting up API documentation portals1718## Do not use this skill when1920- The task is unrelated to openapi spec generation21- You need a different domain or tool outside this scope2223## Instructions2425- Clarify goals, constraints, and required inputs.26- Apply relevant best practices and validate outcomes.27- Provide actionable steps and verification.28- If detailed examples are required, open `resources/implementation-playbook.md`.2930## Resources3132- `resources/implementation-playbook.md` for detailed patterns and examples.
Run npx skillmds@latest add comeonoliver/openapi-spec-generation in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.
OpenAPI Spec Generation It is listed under Coding & Dev Tools on SkillMD.
This skill has not completed SkillMD's automated safety review yet. Independent scanners report: SkillSpector: PASS, Skill Scanner: PASS. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.
This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.
Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.
ComeOnOliver (@comeonoliver) published this skill. Their other Agent Skills are listed on their SkillMD profile.