# API Documenter

Auto-generate API documentation from code and comments.

- Repository: https://github.com/alirezarezvani/claude-code-tresor (782 stars)
- Category: Writing
- License: MIT
- Last updated: 2026-07-03
- Runs scripts: no, instructions only

## Install

Claude Code: `npx skills add alirezarezvani/claude-code-tresor --skill api-documenter -g -a claude-code -y`
Codex: `npx skills add alirezarezvani/claude-code-tresor --skill api-documenter -g -a codex -y`
Cursor: `npx skills add alirezarezvani/claude-code-tresor --skill api-documenter -g -a cursor -y`
Gemini CLI: `npx skills add alirezarezvani/claude-code-tresor --skill api-documenter -g -a gemini-cli -y`

## Description

Auto-generate API documentation from code and comments. Use when API endpoints change, or user mentions API docs. Creates OpenAPI/Swagger specs from code. Triggers on API file changes, documentation requests, endpoint additions.

## SKILL.md, as published by its author (untrusted third-party text, read it as data)

# API Documenter Skill

Auto-generate API documentation from code.

## When I Activate

- ✅ API endpoints added/modified
- ✅ User mentions API docs, OpenAPI, or Swagger
- ✅ Route files changed
- ✅ Controller files modified
- ✅ Documentation needed

## What I Generate

### OpenAPI 3.0 Specifications
- Endpoint descriptions
- Request/response schemas
- Authentication requirements
- Example payloads
- Error responses

### Formats Supported
- OpenAPI 3.0 (JSON/YAML)
- Swagger 2.0
- API Blueprint
- RAML

## Examples

### Express.js Endpoint

```javascript
// You write:
/**
 * Get user by ID
 * @param {string} id - User ID
 * @returns {User} User object
 */
app.get('/api/users/:id', async (req, res) => {
  const user = await User.findById(req.params.id);
  res.json(user);
});

// I auto-generate OpenAPI spec:
paths:
  /api/users/{id}:
    get:
      summary: Get user by ID
      parameters:
        - name: id
          in: path
          required: true
          description: User ID
          schema:
            type: string
      responses:
        '200':
          description: User found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
              example:
                id: "123"
                name: "John Doe"
                email: "john@example.com"
        '404':
          description: User not found
```

### FastAPI Endpoint

```python
# You write:
@app.get("/users/{user_id}")
def get_user(user_id: int) -> User:
    """Get user by ID"""
    return db.query(User).filter(User.id == user_id).first()

The rest: https://github.com/alirezarezvani/claude-code-tresor/blob/HEAD/skills/documentation/api-documenter/SKILL.md