API Documentation Generator
Turns your API code into developer-ready endpoint docs with examples and OpenAPI specs
- Repository
- sickn33/agentic-awesome-skills
- Stars
- 49,023
- Licence
- MIT
- Files
- 1 file
What it does
When installed, the agent reads your API source code (routes, middleware, schemas) and produces structured documentation: endpoint descriptions, parameters, request and response examples in cURL, JavaScript and Python, error catalogues, and optionally an OpenAPI/Swagger spec or Postman collection. It is instructed to mark anything it cannot verify from the code instead of guessing rate limits, token expiry or password rules, and to use placeholder secrets rather than real credentials.
Great for
- Backend developers who need to document a REST, GraphQL or WebSocket API that has little or no documentation
- Teams preparing an API for external partners or onboarding new developers
- Engineers who want a starting OpenAPI draft they will then verify and edit
Skip it if
- Teams expecting fully automatic, verified docs: the skill only reads what it can see and labels inferred behaviour, so every example still needs checking against the running system
- Anyone who would use the 'Try It' interactive calls against production, since the skill notes these are real operations that need an approved sandbox
- Non-developers with no access to the API source code, because the skill depends on reading the codebase
Try asking
- “Document all endpoints in my Express routes folder as a Markdown reference with cURL and Python examples”
- “Generate an OpenAPI 3 spec from my FastAPI application's schemas”
- “Write an authentication guide for my API showing how to get and use a Bearer token”
- “Create error-code documentation for the endpoints in this GraphQL resolver file”
Install in 3 steps
- 1
Download the skill
The ZIP contains the 1 original files, the MIT licence and an attribution note.
api-documentation-generator.zip - 2
Add it to your agent
Claude Code (all projects)
mkdir -p ~/.claude/skills && unzip api-documentation-generator.zip -d ~/.claude/skills/Claude Code / Agent SDK (this project only)
mkdir -p .claude/skills && unzip api-documentation-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 a specific module or route file rather than the whole repository to keep output focused and accurate.
- Ask it to list anything it marked as inferred or missing, then supply those facts yourself before publishing.
- Validate any generated OpenAPI file with a spec validator and run the example requests in a sandbox before sharing.
What's inside
- SKILL.md
Redistributed unmodified from sickn33/agentic-awesome-skills 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.