← ClaudeAtlas

api-docslisted

Generate API documentation by reading route handlers — endpoints, request/response schemas, auth requirements
SilviaAre95/wayworks · ★ 1 · API & Backend · score 75
Install: claude install-skill SilviaAre95/wayworks
# API Documentation Generator Generate API docs for: **$ARGUMENTS** (format defaults to markdown) ## Steps 1. **Discover endpoints** — Scan route files: - Next.js App Router: `app/api/**/route.ts` - Express/Fastify: `routes/**/*.ts` - Read each handler to extract HTTP methods 2. **For each endpoint, extract**: - HTTP method and path - Request body schema (from Zod schemas or TypeScript types) - Query parameters - Path parameters - Response shape (from return statements or response types) - Auth requirements (middleware, decorators, session checks) - Error responses (from error handling code) 3. **Group endpoints** by resource or feature area 4. **Generate documentation**: ### Markdown format ```markdown # API Reference ## Authentication All endpoints except those marked "Public" require a valid session cookie or Bearer token. --- ## Users ### GET /api/users Retrieve a list of users. **Auth**: Admin only **Query Parameters**: | Param | Type | Required | Default | Description | |-------|------|----------|---------|-------------| | page | number | no | 1 | Page number | | limit | number | no | 20 | Items per page | **Response** `200 OK`: \`\`\`json { "users": [{ "id": "...", "name": "...", "email": "..." }], "total": 100, "page": 1 } \`\`\` **Errors**: | Status | Code | Description | |--------|------|-------------| | 401 | UNAUTHORIZED | Missing or invalid session | | 403 | FORBIDDEN | Not an admin | ``` ### OpenAPI format