# api-documentation-generator

Analyzes your codebase to produce API reference pages for REST and GraphQL services. Includes request payloads, status codes, and code snippets.

- skill · `type=skill` · Claude Code · 235 installs
- Author: davila7
- License: not stated · policy=link-only · description only; the file stays with the author
- Source: https://github.com/davila7/claude-code-templates/tree/HEAD/cli-tool/components/skills/development/api-documentation-generator
- Updated: 2026-10-24
- HTML: https://affpapa.org/en/nevibecode/skills/api-documentation-generator

## What it 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.

## Install

### Claude Code (native platform)

1. **claude-code-templates**
```bash
npx claude-code-templates@latest --skill development/api-documentation-generator
```

2. **Skills CLI (Vercel)**
```bash
npx skills add davila7/claude-code-templates --skill api-documentation-generator -a claude-code
```

3. **Manually: put the files in place**
- File: `~/.claude/skills/api-documentation-generator/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/api-documentation-generator/

### Codex

**Manually: put the files in place**
- File: `.agents/skills/api-documentation-generator/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

**Manually: put the files in place**
- File: `.cursor/skills/api-documentation-generator/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install davila7/claude-code-templates api-documentation-generator
```

2. **Manually: put the files in place**
- File: `.github/skills/api-documentation-generator/SKILL.md`

### Gemini CLI

**Platform CLI**
```bash
gemini skills install https://github.com/davila7/claude-code-templates --path cli-tool/components/skills/development/api-documentation-generator
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/api-documentation-generator/SKILL.md` — The legacy .windsurf/skills/ path still works

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/davila7/claude-code-templates/tree/HEAD/cli-tool/components/skills/development/api-documentation-generator

## When to use it
- 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
- 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

## Similar
- [mcp-builder](https://affpapa.org/en/nevibecode/skills/mcp-builder.md) — skill · 130949 installs
- [claude-api](https://affpapa.org/en/nevibecode/skills/claude-api.md) — skill · 74198 installs
- [lark-im](https://affpapa.org/en/nevibecode/skills/lark-im.md) — skill · 472900 installs
- [lark-event](https://affpapa.org/en/nevibecode/skills/lark-event.md) — skill · 466800 installs
- [caveman-discover](https://affpapa.org/en/nevibecode/skills/caveman-discover.md) — skill · 104400 installs
- [migration](https://affpapa.org/en/nevibecode/skills/migration.md) — skill · 103900 installs

From the same set: [davila7/claude-code-templates](https://affpapa.org/en/nevibecode/by/davila7/claude-code-templates.md) — 804 cards

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md