openapi-spec-generator

Generate OpenAPI 3.x YAML specifications by analyzing project code and documentation.

2|1|Updated Feb 2, 2019
One-click install
npx skills add https://github.com/Foo-x/dotfiles --skill openapi-spec-generator
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: openapi-spec-generator
Source: https://github.com/Foo-x/dotfiles/tree/main/claude/skills/openapi-spec-generator
Command: npx skills add https://github.com/Foo-x/dotfiles --skill openapi-spec-generator

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires pyyaml, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the creation of OpenAPI 3.x specification documents for your RESTful APIs, eliminating the manual effort and potential for errors in documentation.

Core Features & Use Cases

  • Automatic API Specification Generation: Analyzes project code and documentation to generate OpenAPI 3.x YAML files.
  • Framework Detection: Automatically detects common web frameworks (Express, FastAPI, Flask, Spring Boot, Gin, Echo, Rails, Laravel) to tailor its analysis.
  • Endpoint & Schema Extraction: Extracts API endpoints, request/response models, and parameters directly from your codebase.
  • Use Case: You've just finished building a new API with FastAPI, but need to generate an OpenAPI spec for integration with third-party tools. This Skill can analyze your project and produce the openapi.yaml file in minutes.

Quick Start

Use the openapi-spec-generator skill to create an OpenAPI 3.2 specification for the current project.

Frequently Asked Questions about openapi-spec-generator

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

FAQPage Schema
How do I generate an OpenAPI 3.x specification from my existing codebase?

This Skill automates OpenAPI specification generation by detecting your web framework and extracting API endpoints, request/response models, and parameters directly from your project code into a valid YAML file.

Does the OpenAPI spec generator work with frameworks like FastAPI, Flask, or Spring Boot?

Yes, the OpenAPI spec generator automatically detects common web frameworks including Express, FastAPI, Flask, Spring Boot, Gin, Echo, Rails, and Laravel to tailor its endpoint and schema extraction analysis.

Can I automatically extract API endpoints and response models from my REST API code?

Yes, you can automatically extract API endpoints and response models from REST API code. This Skill analyzes your project structure to identify routes and data schemas, facilitating API discovery and integration without manual schema definitions.

Do I need to install pyyaml to generate OpenAPI documents from my code?

Yes, you need to install pyyaml to generate OpenAPI documents from your code. This dependency is required by the Skill to properly parse configuration files and output the final OpenAPI 3.x YAML specification document.

What is the best way to automate REST API documentation for multiple programming languages?

The best way to automate REST API documentation for multiple programming languages is using a tool that analyzes project code and configuration files directly. This Skill supports multiple languages and frameworks to generate comprehensive OpenAPI 3.x specs.