command-api-docs

A Claude Code slash command for generating API documentation from code.

Installation

# Clone to your preferred location
git clone git@github.com:claude-commands/command-api-docs.git <clone-path>/command-api-docs

# Symlink (use full path to cloned repo)
ln -s <clone-path>/command-api-docs/api-docs.md ~/.claude/commands/api-docs.md
```text

## Usage

```text
/api-docs              # Generate full API docs
/api-docs src/routes/  # Document specific routes
/api-docs --openapi    # Generate OpenAPI spec
/api-docs --markdown   # Generate markdown docs
/api-docs --postman    # Generate Postman collection
```text

## What it does

1. Detects API framework (Express, Gin, FastAPI, etc.)
2. Finds all route definitions
3. Extracts endpoint information
4. Parses request/response types
5. Generates documentation in specified format

## Output Formats

### OpenAPI (openapi.yaml)

```yaml
openapi: 3.0.3
paths:
  /api/users:
    get:
      summary: List all users
      responses:
        '200':
          description: Success
```text

### Markdown (API.md)

```markdown
## GET /users
Returns a paginated list of users.

**Response:**
```json
{"users": [...], "total": 100}
```text

```text

### Postman Collection
```json
{
  "name": "List Users",
  "request": {
    "method": "GET",
    "url": "{{baseUrl}}/users"
  }
}
```text

## Framework Support

| Framework | Language |
|-----------|----------|
| Express | Node.js |
| Fastify | Node.js |
| Gin | Go |
| Echo | Go |
| FastAPI | Python |
| Django REST | Python |

## Requirements

- API source code with route definitions
- Claude Code with Opus 4.5 model access

## Updates

```bash
cd <clone-path>/command-api-docs && git pull
```text