api-documentation-generator — Claude Code skill: setup guide
Analyzes your codebase to produce API reference pages for REST and GraphQL services. Includes request payloads, status codes, and code snippets.
npx claude-code-templates@latest --skill development/api-documentation-generatorWhat api-documentation-generator does
Inspects server route declarations directly from your repository. It outlines HTTP methods, path variables, payload validations, and expected response codes. This helps when onboarding teammates or sharing public guides.
Produces call examples in cURL and JavaScript. It also documents authentication flows, pagination parameters, rate limits, and failure responses.
Can prepare an OpenAPI specification if needed. Precise outputs require Claude Code to access your router and model source files.
What it helps with
- inspect source code to document routes, parameters, and responses
- create reproducible request samples in cURL and JavaScript
- build error resolution guides with specific status codes
- export OpenAPI specifications and Postman collections from endpoints
Example prompts for the agent
- Inspect the routes in src/api and build an API reference document
- Document our auth endpoints with token refresh steps and cURL snippets
- Generate an OpenAPI spec based on the controllers in this repository
How to install api-documentation-generator
1claude-code-templates
npx claude-code-templates@latest --skill development/api-documentation-generator2Skills CLI (Vercel)
npx skills add davila7/claude-code-templates --skill api-documentation-generator -a claude-code3Manually: put the files in place
~/.claude/skills/api-documentation-generator/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/api-documentation-generator/
Manually: put the files in place
.agents/skills/api-documentation-generator/SKILL.mdFor all projects use ~/.agents/skills/
Manually: put the files in place
.cursor/skills/api-documentation-generator/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install davila7/claude-code-templates api-documentation-generator2Manually: put the files in place
.github/skills/api-documentation-generator/SKILL.mdPlatform CLI
gemini skills install https://github.com/davila7/claude-code-templates --path cli-tool/components/skills/development/api-documentation-generatorManually: put the files in place
.devin/skills/api-documentation-generator/SKILL.mdThe legacy .windsurf/skills/ path still works
Claude.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 api-documentation-generator
How do I install api-documentation-generator in Claude Code?
Run npx claude-code-templates@latest --skill development/api-documentation-generator in your project terminal.
Which API architectures can this skill document?
It covers REST endpoints, GraphQL queries and mutations, as well as WebSocket interfaces.
What code snippets does it include in endpoint guides?
It generates commands for cURL, JavaScript snippets with fetch or axios, and Python examples using requests.