---
name: API Documentation Generator
slug: api-documentation-generator-3
category: Writing
description: API Documentation Generator creates endpoint documentation from source code and can also produce OpenAPI/Swagger specs. Use it when you need API docs, endpoint summaries, or route details from an existing codebase.
github: "https://github.com/huangjia2019/claude-code-engineering/tree/main/04-Skills/projects/05-api-generator"
language: JavaScript
stars: 1077
forks: 379
install: "npx degit https://github.com/huangjia2019/claude-code-engineering/tree/main/04-Skills/projects/05-api-generator ~/.claude/skills/05-api-generator"
installs_to: ~/.claude/skills/05-api-generator
source_path: 04-Skills/projects/05-api-generator/SKILL.md
collection_size: 13
category_size: 1012
collection_url: "https://dirskills.com/collections/huangjia2019/claude-code-engineering"
added: 2026-08-21T05:13:26.521Z
last_synced: 2026-08-21T05:13:26.521Z
canonical_url: "https://dirskills.com/skills/api-documentation-generator-3"
---

# API Documentation Generator

API Documentation Generator creates endpoint documentation from source code and can also produce OpenAPI/Swagger specs. Use it when you need API docs, endpoint summaries, or route details from an existing codebase.

**Install:**

```bash
npx degit https://github.com/huangjia2019/claude-code-engineering/tree/main/04-Skills/projects/05-api-generator ~/.claude/skills/05-api-generator
```

## README

# API Documentation Generator

Generate comprehensive API documentation from source code.

## Quick Reference

| Task | Resource |
|------|----------|
| Identify framework | See `PATTERNS.md` |
| Documentation standards | See `STANDARDS.md` |
| Example outputs | See `EXAMPLES.md` |

## Process

### Step 1: Identify API Endpoints

Look for route definitions. For framework-specific patterns, see `PATTERNS.md`.

### Step 2: Extract Information

For each endpoint, extract:
- HTTP method (GET, POST, PUT, DELETE, etc.)
- Path/route
- Parameters (path, query, body)
- Request/response schemas
- Authentication requirements

### Step 3: Generate Documentation

Use the template in `templates/endpoint.md` for each endpoint.

### Step 4: Create Overview

Generate an index using `templates/index.md`.

## Output Formats

### Markdown (Default)
Generate markdown suitable for README or docs site.

### OpenAPI/Swagger
If requested, generate OpenAPI 3.0 spec. See `templates/openapi.yaml`.

## Automation

To auto-detect routes:
```bash
python scripts/detect_routes.py <source_directory>
```

To validate OpenAPI spec:
```bash
./scripts/validate_openapi.sh <spec_file>
```