Api Docs Writer

API Docs Writer

Generate complete API documentation by analyzing route handler source code.

Workflow

1. Find all API routes

Search for API route files:

• Next.js: app/api/**/route.ts
• Express: files with router.get/post/put/delete
• FastAPI: files with @app.get/post/put/delete

1. Analyze each route

For every endpoint, extract:

• HTTP method (GET, POST, PUT, DELETE)
• URL path and path parameters
• Query parameters
• Request body schema (from TypeScript types or validation)
• Response schema (from return statements)
• Authentication requirements
• Error responses

1. Generate documentation using this format for each endpoint:

### [METHOD] /api/path

[One-line description]

**Authentication:** Required / None

**Request**

| Parameter | Type   | In    | Required | Description |
|-----------|--------|-------|----------|-------------|
| id        | string | path  | yes      | Resource ID |

**Request Body**
\`\`\`json
{
  "field": "value"
}
\`\`\`

**Response (200)**
\`\`\`json
{
  "data": { ... }
}
\`\`\`

**Error Responses**
| Status | Description |
|--------|-------------|
| 401    | Unauthorized |
| 404    | Not found   |

1. Write the output

Create or update the docs file (e.g., docs/API.md or API_REFERENCE.md).

Rules

• Include curl examples for each endpoint
• Show both success and error response examples
• Group endpoints by resource/domain
• Note any rate limits or special headers required
• Include authentication details (Bearer token, API key, cookies)
• Link to related endpoints where relevant

Source & license

This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.

• Author: sourav15mukherjee
• Source: sourav15mukherjee/skillforge-free-skills
• License: MIT

Install and usage instructions live in the source repository linked above.