skills.rest
haxlys
haxlysCOMMUNITY
Explore all skills by this author →
GitHub

openapi-spec-generation

Generate OpenAPI 3.1 specifications from code and design artifacts.

1|Updated Apr 27, 2026
Search Tags:#openapi#validation#sdk#code-generation#api-docs#design-first
One-click install
npx skills add https://github.com/haxlys/skills --skill openapi-spec-generation-haxlys
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: openapi-spec-generation
Source: https://github.com/haxlys/skills/tree/main/vendored/wshobson-agents/plugins/documentation-generation/skills/openapi-spec-generation
Command: npx skills add https://github.com/haxlys/skills --skill openapi-spec-generation-haxlys

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Automates the creation, maintenance, and validation of OpenAPI 3.1 specifications from code, design-first schemas, and validation rules to keep API docs in sync with implementations.

Core Features & Use Cases

  • Design-first and code-first OpenAPI generation from source code and design artifacts
  • Validation, linting, and SDK generation templates to accelerate API delivery
  • Supports exporting JSON/YAML specs and generating client code across languages

Quick Start

Run the tool on your project to generate or update the OpenAPI spec from code and design artifacts.

Frequently Asked Questions about openapi-spec-generation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate OpenAPI 3.1 specifications from existing code?▼

You can generate OpenAPI 3.1 specifications from existing code by running the tool on your project to analyze source code, validation patterns, and design artifacts to create accurate API documentation.

Does OpenAPI spec generation support both design-first and code-first workflows?▼

Yes, OpenAPI spec generation supports both design-first and code-first workflows, allowing you to create or update API schemas from design artifacts or source code to align documentation with implementation.

Can I generate SDK client code from an OpenAPI 3.1 spec?▼

Yes, you can generate SDK client code from an OpenAPI 3.1 spec using built-in templates for Python and TypeScript to accelerate API delivery and client generation across languages.

How do I validate and lint OpenAPI specifications during API development?▼

You can validate and lint OpenAPI specifications during API development by applying the tool to check design artifacts and source code against OpenAPI 3.1 syntax rules to ensure alignment.

What formats can I export OpenAPI specifications to?▼

You can export OpenAPI specifications to JSON and YAML formats, allowing you to share API documentation, validate schemas, and generate client code across different platforms.

What inputs do I need to align API documentation with implementation?▼

To align API documentation with implementation, you need access to source code or design inputs along with OpenAPI 3.1 syntax support to automate spec creation, maintenance, and validation.

Related Skills

Explore More Software Engineering Skills→
iCesofTiCesofT
1

openapi-spec-generation

Generate and maintain OpenAPI 3.1 specifications from code and design inputs.

Community
Advanced
ArogyaReddyArogyaReddy

openapi-spec-generation

Generate and maintain OpenAPI 3.1 specifications for RESTful APIs.

Community
Advanced
wshobsonwshobson
38.6k

openapi-spec-generation

Generates and maintains OpenAPI 3.1 specifications for RESTful APIs.

Community
Advanced
avdelag1avdelag1

openapi-spec-generation

Generate OpenAPI 3.1 specifications from code, annotations, or design-first inputs.

Community
Intermediate