skills.rest
xotong
xotongCOMMUNITY
Explore all skills by this author →
GitHub

openapi-spec-generation

Generate or update OpenAPI 3.1 specs from API route changes.

2|Updated May 8, 2026
Search Tags:#documentation#openapi#validation#swagger#routes#code-sync#api-spec
One-click install
npx skills add https://github.com/xotong/claude-marketplace --skill openapi-spec-generation-xotong
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: openapi-spec-generation
Source: https://github.com/xotong/claude-marketplace/tree/main/plugins/code-quality/skills/openapi-spec-generation
Command: npx skills add https://github.com/xotong/claude-marketplace --skill openapi-spec-generation-xotong

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generate or update the OpenAPI (Swagger) specification to stay in sync with implemented API routes, reducing drift and manual toil.

Core Features & Use Cases

  • Auto-detect existing specs across common formats (openapi.yaml/json, swagger.yaml/json) and initialise when absent.
  • Integrate with framework tooling (tsoa, swagger-jsdoc, FastAPI, drf-spectacular, springdoc, swaggo) to generate or update openapi files.
  • Validate and emit a clean, compliant OpenAPI 3.1 spec, with steps for updating paths and components.

Quick Start

Use the openapi-spec-generation skill to create or refresh the API specification whenever routes change to keep docs accurate.

Frequently Asked Questions about openapi-spec-generation

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

FAQPage Schema
How do I automatically sync my OpenAPI spec with code changes?▼

To sync your OpenAPI spec with code changes, auto-generation tooling aligns API documentation with implemented routes by detecting existing files and validating against OpenAPI 3.1 compliance.

What is the best way to generate an OpenAPI 3.1 spec for a FastAPI project?▼

Generating an OpenAPI 3.1 spec for FastAPI integrates with framework tooling like drf-spectacular or swagger-jsdoc to extract schemas and emit a clean, compliant specification file.

Does OpenAPI auto-generation work with Node.js Express and Spring Boot?▼

OpenAPI auto-generation works with Node.js/Express and Spring Boot by integrating with tsoa and springdoc tooling to update paths and components when API routes change.

Can I create an openapi.yaml scaffold if one is missing?▼

You can create an openapi.yaml scaffold if missing by initializing a base file that auto-detects common formats like swagger.json and prepares the structure for route updates.

Why does my Swagger documentation drift from my implemented API routes?▼

Swagger documentation drifts from implemented API routes when manual updates lag behind code changes, requiring auto-generation tooling to validate and align schemas continuously.

Related Skills

Explore More Software Engineering Skills→
amanning3390amanning3390
13

api-builder

Generate OpenAPI 3.0 specs and scaffold REST and GraphQL APIs.

Community
Advanced
epieczkoepieczko

api.validate

Validate OpenAPI 3.x and AsyncAPI 3.x specifications against Zalando guidelines.

Community
Intermediate
AI-Foundry-CoreAI-Foundry-Core
4

openapi-spec-generation

Generate OpenAPI 3.1 specifications from code and design artifacts.

Official
Advanced
giuseppe-trisciuogliogiuseppe-trisciuoglio
322

spring-boot-openapi-documentation

Generate OpenAPI 3.0 documentation and Swagger UI for Spring Boot 3.x applications.

Community
Advanced