Generate Swagger Docs

Automatically generates OpenAPI 3.0 specs and interactive Swagger UI docs by scanning your codebase for API endpoints. It uses the apimesh tool under the hood, which requires an OpenAI API key to analyze your code and detect frameworks like Express, FastAPI, Django, or Rails. The wrapper script handles the annoying parts of environment variable propagation so the key actually reaches the subprocess. Outputs swagger.json and a self-contained HTML file you can share. One catch: your API key gets saved locally in config.json, so make sure that's gitignored. Works well if you need docs fast and don't want to hand-write OpenAPI specs.

skills.sh installs: 255
GitHub stars: 48
last updated: Aug 21, 2026

View on GitHub

Install

$ npx -y skills add qodex-ai/ai-agent-skills --skill generate-swagger-docs --agent claude-code

Installs into .claude/skills of the current project.

Files

Generate Swagger Documentation

Generate OpenAPI docs from your codebase in seconds with automatic API key setup.

How It Works

This skill automates the Swagger/OpenAPI documentation generation:

API Key Setup - Accepts your OpenAI API key and sets it as an environment variable
Initialization - Downloads and sets up the apimesh tool
Automatic Processing - The tool analyzes your codebase and generates documentation
Output - Outputs are saved to the apimesh/ directory

Setup Requirements

You need an OpenAI API key to use this skill. Get one from OpenAI's platform if you don't have one already.

Recommended: Quick Setup with API Key

The easiest way to use this skill is to pass your API key directly:

/Users/ankits/.claude/skills/generate-swagger-docs/generate-with-key.sh "sk-proj-your-api-key-here"

This will:

Accept your OpenAI API key as an argument
Create the apimesh/ directory and download the apimesh tool
Set up the environment variables correctly
Generate your Swagger documentation automatically
Display the output file locations

Automatic Flow

SKILL.md on GitHub

Details

Repository: github.com/qodex-ai/ai-agent-skills
Categories: Frontend Development, Backend & APIs, Documentation, AI & Agent Building
First seen: Jun 3, 2026