REST API Documentation Generator

Produces clear, consistent, professional API reference documentation. Covers: HTTP method, path, description, authentication, request parameters (path, query, body), response schema, status codes, and usage examples.

Workflow

1. Gather input — accept any of: raw endpoint list, code (routes/controllers), curl examples, OpenAPI YAML/JSON, or plain prose description.
2. Infer missing details — use naming conventions, HTTP verbs, and context to fill in reasonable defaults. Flag assumptions explicitly.
3. Choose output format — default is a clean Markdown file; see Format Options below.
4. Generate documentation — follow the Endpoint Block Template for every endpoint.
5. Save to file — always write output to /mnt/user-data/outputs/api-docs.md (or .html / openapi.yaml if requested) and present it with present_files.

Format Options

| Format | When to use |