api-docs-generator

Generates API documentation in Markdown, HTML, or Docusaurus format from Express, Next.js, and Fastify routes.

Updated Mar 16, 2026
One-click install
npx skills add https://github.com/zinohome/RTMessage --skill api-docs-generator-zinohome
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-docs-generator
Source: https://github.com/zinohome/RTMessage/tree/main/.github/skills/api-docs-generator
Command: npx skills add https://github.com/zinohome/RTMessage --skill api-docs-generator-zinohome

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires commander.

What problem does it solve? Writing and maintaining API documentation by hand is slow and quickly drifts out of sync with actual route implementations. This Skill scans API route definitions and produces structured endpoint references, authentication guides, and error documentation automatically. ## Core Features & Use Cases - Route Scanning and Extraction: Finds API route definitions in Express, Next.js, or Fastify projects and extracts methods, paths, parameters, request bodies, and response schemas. - Structured Documentation Output: Generates an API overview, authentication guide, error reference, per-resource endpoint pages, and a getting-started guide in Markdown, HTML, or Docusaurus format. - Request/Response Examples: Produces cURL examples and JSON request/response samples for every endpoint, including authentication headers and error codes. - Use Case: After adding new endpoints to an Express backend, run the generator to regenerate the full docs directory so the public API reference always matches the implemented routes. ## Quick Start Generate API documentation for all routes in my Express project under ./src and output it to ./docs in Markdown format.

Frequently Asked Questions about api-docs-generator

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate API documentation from Express routes?▼

Run the docs-gen CLI with the framework set to express, pointing --source at your routes directory and --output at your docs folder. The script scans route definitions, groups them by resource, and writes endpoint pages, an overview, and an authentication guide.

What output formats does API documentation generation support?▼

The generator supports Markdown, HTML, and Docusaurus output formats, selected via the --format CLI option. Markdown is the default and produces a docs directory with api, guides, and sdks subfolders.

Does the API docs generator work with Next.js and Fastify?▼

Yes, the CLI accepts express, nextjs, and fastify as framework options. Route scanning adapts to each framework's route definition style before extracting methods, parameters, and schemas.

How are request and response examples added to endpoint docs?▼

Examples come from the example fields defined in each route's schema and response metadata. The generator renders them as JSON code blocks and builds a cURL command with the method, URL, auth header, and request body for every endpoint.

What are the limitations of automatic API documentation generation?▼

Generated docs only reflect what is declared in route definitions, so undocumented behavior, implicit middleware logic, and business rules require manual writing. Routes without schema metadata produce generic response sections with default status codes.