Skip to main content
skill CX Codex

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

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add qodex-ai/ai-agent-skills --skill generate-swagger-docs -a claude-code
Open on GitHub

What 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.json and place the HTML docs beside it.
  • Detect the API framework and run the generator through generate-with-key.sh using 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-code

2Manually: put the files in place

~/.claude/skills/generate-swagger-docs/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/generate-swagger-docs/

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.

Similar skills

All skills for Backend and APIs →

From the same set42

The whole set →
chat-with-arxiv chat-with-arxiv searches ArXiv preprints, parses PDF files, and generates answers with source citations. Designed for literature reviews and cross-paper synthesis. CX Codex +1 305installs deep-research-agent deep-research-agent is a Claude Code skill that automates data collection, source validation and report writing for market overviews, competitive analysis and academic literature reviews. CX Codex +1 290installs autonomous-agent-gaming autonomous-agent-gaming is a skill with runnable examples of rule-based, minimax, MCTS and Q-learning bots, plus a chess engine for agents choosing game moves. CX Codex +1 274installs rag-agent-builder rag-agent-builder provides templates and scripts to build RAG pipelines with vector databases, hybrid retrieval, and response evaluation. CX Codex +1 263installs voice-ai-integration voice-ai-integration turns spoken input into an answer: speech recognition, intent parsing, then a synthesized reply. Python examples for Whisper, Google Cloud, Azure and ElevenLabs. CX Codex +1 211installs presentation-builder presentation-builder is a Claude Code skill that creates and edits PowerPoint files. It handles tasks involving slides, layouts, animations, and speaker notes. CX Codex +1 203installs llm-fine-tuning-guide llm-fine-tuning-guide guides LLM fine-tuning workflows across full training, LoRA, and QLoRA. Helps adapt open weights to specific domains, style requirements, and limited hardware budgets. CX Codex +1 196installs aesthetic-analysis The aesthetic-analysis skill studies a visual reference and helps rebuild its layout, colors, and typography in React Native. Use it for landing page redesigns based on a site or image. CX Codex +1 193installs

Project sponsors

Companies that keep this analytics open