generate-swagger-docs
OfficialAuto-generate API docs from code.
Software Engineering#code analysis#openapi#swagger#documentation generation#rest api#api documentation
Authorqodex-ai
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill automates the generation of OpenAPI (Swagger) documentation directly from your codebase, simplifying the process of documenting REST APIs.
Core Features & Use Cases
- Automatic API Discovery: Analyzes your source code to find and document API endpoints.
- OpenAPI Spec Generation: Creates
swagger.json(OpenAPI 3.0) and interactive HTML documentation. - Framework Agnostic: Supports popular web frameworks like Express, NestJS, FastAPI, Django, Rails, and Go.
- Use Case: You've just finished building a new REST API and need to quickly generate documentation for your team and for integration purposes.
Quick Start
Run the provided script with your OpenAI API key to generate the documentation.
Dependency Matrix
Required Modules
None requiredComponents
scripts
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: generate-swagger-docs Download link: https://github.com/qodex-ai/ai-agent-skills/archive/main.zip#generate-swagger-docs Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.