generate-swagger-docs — Claude Code skill: what it does, install
generate-swagger-docs scans a codebase for API endpoints and produces an OpenAPI file plus interactive HTML docs. Use it when a REST API needs generated documentation.
no license 260 installs ★ 50 updated 2026-01-05
npx skills add qodex-ai/ai-agent-skills --skill generate-swagger-docs -a claude-codeWhat generate-swagger-docs does
This skill inspects a repository, identifies its web framework, and maps the API endpoints it finds. It writes an OpenAPI 3.0 document to apimesh/swagger.json and creates a standalone HTML page at apimesh/apimesh-docs.html for browsing the result.
A shell wrapper accepts the OpenAI key, prepares the apimesh directory, and runs the apimesh tool. Framework detection covers Django, Flask, FastAPI, Express, NestJS, Rails, and Go; a framework can also be supplied manually.
An OpenAI API key is required for the code analysis. The run stores settings in apimesh/config.json, so that file belongs in .gitignore because it can contain secrets. Documentation generation stops without the key.
What it helps with
- discover API endpoints across a repository
- produce an OpenAPI 3.0 specification
- build interactive HTML API docs
- identify the project’s web framework
- store run settings in
apimesh/config.json
Example prompts for the agent
- Scan this repository and document every API endpoint you find.
- Generate the OpenAPI file at
apimesh/swagger.jsonand place the HTML docs beside it. - Detect the API framework and run the generator through
generate-with-key.shusing my OpenAI key.
How to install generate-swagger-docs
1Skills CLI (Vercel)
npx skills add qodex-ai/ai-agent-skills --skill generate-swagger-docs -a claude-code2Manually: put the files in place
~/.claude/skills/generate-swagger-docs/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/generate-swagger-docs/
1Skills CLI (Vercel)
npx skills add qodex-ai/ai-agent-skills --skill generate-swagger-docs -a codex2Manually: put the files in place
.agents/skills/generate-swagger-docs/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add qodex-ai/ai-agent-skills --skill generate-swagger-docs -a cursor2Manually: put the files in place
.cursor/skills/generate-swagger-docs/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install qodex-ai/ai-agent-skills skills/generate-swagger-docs2Manually: put the files in place
.github/skills/generate-swagger-docs/SKILL.md1Skills CLI (Vercel)
npx skills add qodex-ai/ai-agent-skills --skill generate-swagger-docs -a gemini-cli2Platform CLI
gemini skills install https://github.com/qodex-ai/ai-agent-skills --path skills/generate-swagger-docsManually: put the files in place
.devin/skills/generate-swagger-docs/SKILL.mdThe legacy .windsurf/skills/ path still works
Skills CLI (Vercel)
npx skills add qodex-ai/ai-agent-skills --skill generate-swagger-docs -a opencodeClaude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
Step by step, with commands for each platform: How to install skills in Claude Code: five ways
Questions about generate-swagger-docs
How do I install generate-swagger-docs in Claude Code?
Run npx skills add qodex-ai/ai-agent-skills --skill generate-swagger-docs -a claude-code, then use ~/.claude/skills/generate-swagger-docs/SKILL.md.
What does generate-swagger-docs do?
It scans source code for API endpoints, identifies the framework, and writes an OpenAPI 3.0 file to apimesh/swagger.json. It also creates interactive HTML docs at apimesh/apimesh-docs.html.
What does the skill need to run?
The analysis requires an OpenAI API key. Settings are saved in apimesh/config.json, which should be excluded through .gitignore.