API Doc Generator
Generates accurate API documentation and OpenAPI specs from source code.
- Repository
- luongnv89/claude-howto
- Stars
- 46,401
- Licence
- MIT
- Files
- 1 file
What it does
When installed, the agent produces structured API documentation from your source code: an OpenAPI/Swagger specification, per-endpoint pages with parameters, example success and error responses, cURL, JavaScript and Python examples, plus authentication guides and error code references. It follows a fixed template so each endpoint is documented in the same consistent layout. The skill itself is only written instructions; it does not add any tools or scripts.
Great for
- Backend developers who need to document an existing REST API quickly
- Teams that want an OpenAPI spec generated from code as a starting point
- Anyone maintaining SDK or integration guides for an API
Skip it if
- APIs whose behaviour is not in the code: the agent may invent parameters, responses or error codes, so outputs must be checked against the real service
- Publishing documentation without review, since generated examples such as sample emails and tokens may not match production behaviour
Try asking
- “Generate OpenAPI documentation for the user routes in this project”
- “Write endpoint docs for GET /api/v1/users/:id including cURL and Python examples”
- “Create an authentication guide and error code reference for this API”
Install in 3 steps
- 1
Download the skill
The ZIP contains the 1 original files, the MIT licence and an attribution note.
doc-generator.zip - 2
Add it to your agent
Claude Code (all projects)
mkdir -p ~/.claude/skills && unzip doc-generator.zip -d ~/.claude/skills/Claude Code / Agent SDK (this project only)
mkdir -p .claude/skills && unzip doc-generator.zip -d .claude/skills/Claude apps (web/desktop): Settings → Capabilities → Skills → Upload skill, and choose the ZIP.
- 3
Ask for the task
No special command needed — the agent reads the skill's description and loads it when your request matches. Try one of the prompts above.
Get better results
- Point the agent at the specific route or controller files so it documents real code rather than guessing.
- Review every generated parameter, status code and example against the actual implementation before publishing.
- Ask for the output format you need (OpenAPI YAML, Markdown pages) in the request to get consistent results.
What's inside
- SKILL.md
Redistributed unmodified from luongnv89/claude-howto under the MIT licence. The assessment was drafted with AI from the skill's files on 2026-10-29. Skills can instruct your agent to run code — read SKILL.md and any scripts before installing.