api-docs-gen

Name: api-docs-gen
Availability: InStock
Author: jieni777

Generate Markdown docs or OpenAPI specs from route files.

1|Updated Jan 30, 2026

Search Tags:#documentation #markdown #openapi #codebase #api-docs #automated #route-files

Ready to run

npx skills add https://github.com/jieni777/opencode-config-backup --skill api-docs-gen

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: api-docs-gen
Source: https://github.com/jieni777/opencode-config-backup/tree/main/skills/ai-api-docs
Command: npx skills add https://github.com/jieni777/opencode-config-backup --skill api-docs-gen

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automatically generate clear API documentation from your route files, delivering Markdown docs or OpenAPI specs quickly to reduce manual writing.

Core Features & Use Cases

Parses route files to extract endpoints, methods, and paths
Generates Markdown documentation suitable for README or docs sites
Produces OpenAPI 3.0 specifications for tooling like Swagger
Documents request/response shapes automatically

Quick Start

Run the tool to generate docs from your route definitions with a single command.

Frequently Asked Questions about api-docs-gen

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

FAQPage Schema

How do I generate API documentation from route files automatically?▼

To generate API documentation from route files automatically, you can use a tool that parses route definitions in directories like src/routes to extract endpoints, methods, and paths, then outputs Markdown or OpenAPI specs without manual writing.

Can I generate OpenAPI specs from existing route definitions without writing config files?▼

Yes, you can generate OpenAPI 3. specifications from existing route definitions without configuration by parsing route metadata and inferring request and response shapes to produce machine-readable docs for tooling like Swagger.

How do I extract request and response shapes for Markdown API docs?▼

You can extract request and response shapes for Markdown API docs by using automated documentation generation that parses route metadata from your codebase, inferring data structures to produce human-readable Markdown documentation.

Does automated API documentation generation work with any project directory structure?▼

Automated API documentation generation applies to projects with route definitions in src/routes or similar directories. It parses route metadata from these specific locations to infer request and response shapes for documentation output.

What is the best way to keep API documentation consistent with codebase changes?▼

The best way to keep API documentation consistent with codebase changes is to generate docs directly from route files, parsing route metadata and inferring shapes to produce Markdown or OpenAPI specs quickly and reduce manual writing errors.

Why does automated route file documentation produce both Markdown and OpenAPI formats?▼

Automated route file documentation produces both Markdown and OpenAPI formats to deliver human-readable docs for README or docs sites and machine-readable OpenAPI 3.0 specifications for tooling like Swagger, ensuring faster, consistent API documentation.