API Docs Writer

Generate comprehensive API documentation from your codebase — OpenAPI specs, endpoint references, request/response examples, and integration guides.

Features

• Auto-Discovery — Scans route handlers, controllers, and decorators to find all API endpoints
• OpenAPI Generation — Produces valid OpenAPI 3.1 specifications from your source code
• Example Generation — Creates realistic request/response examples for every endpoint
• Error Catalog — Documents all error responses with status codes and resolution guidance
• Integration Guide — Generates quickstart guides with cURL, fetch, and SDK code samples

Quick Start

claude skill install api-docs-writer

Usage

# Generate API docs from your Express/FastAPI/Next.js routes
/api-docs-writer generate

# Create an OpenAPI spec from source code
/api-docs-writer openapi --output api-spec.yaml

How It Works

Parses your route definitions, middleware, validation schemas, and type annotations to build a complete API model. Generates documentation that includes authentication requirements, rate limits, pagination patterns, and error handling. Outputs in multiple formats: Markdown, OpenAPI YAML, and interactive HTML.

Compatibility

Works with Claude Code, Codex, Gemini CLI, Cursor, Windsurf, and Aider.