api-docs

Files

---
name: api-docs
description: Generate API documentation from code
version: 1.5.0
---

# API Documentation Generator

Automatically generate OpenAPI/Swagger documentation from your code.

## Supported Frameworks

- Express.js
- Fastify
- Next.js API Routes
- NestJS
- FastAPI
- Flask

## Features

- Extract endpoints from route files
- Generate request/response schemas
- Support TypeScript types
- Output OpenAPI 3.0 format
- Include examples

## Output Formats

- OpenAPI 3.0 YAML
- OpenAPI 3.0 JSON
- Markdown documentation
- HTML documentation (Swagger UI)

## Usage

```
api-docs generate --input ./routes --output ./docs/api.yaml
api-docs serve --port 3001
```

## Example Output

```yaml
openapi: 3.0.0
info:
  title: My API
  version: 1.0.0
paths:
  /users:
    get:
      summary: List users
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'
```