rest-api-doc
Installation
SKILL.md
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
- Gather input — accept any of: raw endpoint list, code (routes/controllers), curl examples, OpenAPI YAML/JSON, or plain prose description.
- Infer missing details — use naming conventions, HTTP verbs, and context to fill in reasonable defaults. Flag assumptions explicitly.
- Choose output format — default is a clean Markdown file; see Format Options below.
- Generate documentation — follow the Endpoint Block Template for every endpoint.
- Save to file — always write output to
/mnt/user-data/outputs/api-docs.md(or.html/openapi.yamlif requested) and present it withpresent_files.