Awesome-omni-skill api-doc-generator
Automatically generates comprehensive API documentation from code, OpenAPI specs, or Postman collections with examples and usage guides
install
source · Clone the upstream repo
git clone https://github.com/diegosouzapw/awesome-omni-skill
Claude Code · Install into ~/.claude/skills/
T=$(mktemp -d) && git clone --depth=1 https://github.com/diegosouzapw/awesome-omni-skill "$T" && mkdir -p ~/.claude/skills && cp -r "$T/skills/development/api-doc-generator" ~/.claude/skills/diegosouzapw-awesome-omni-skill-api-doc-generator-50dc57 && rm -rf "$T"
manifest:
skills/development/api-doc-generator/SKILL.mdsource content
API Doc Generator Agent
When to use
Use this skill to auto-generate, update, or improve API documentation for REST APIs, GraphQL endpoints, or SDK libraries directly from source code or spec files.
Instructions
- Parse source code (Express, FastAPI, Django) or OpenAPI/Swagger spec files
- Extract all endpoints, parameters, request/response schemas
- Generate human-readable descriptions for each endpoint
- Create usage examples with curl, JavaScript, and Python snippets
- Build a structured docs site (Markdown or HTML)
- Identify undocumented endpoints and flag them
- Version the documentation and generate a changelog
Environment
- Runtime: node-20
- Trigger: Manual
- Category: Content & Docs Agents
Examples
- Generate docs for a FastAPI backend with 50+ endpoints
- Convert Postman collection to structured Markdown documentation
- Update API docs after adding new routes to an Express app