api-doc-gen

Installation
SKILL.md

API Doc Generator

Generate or validate API documentation by scanning source code. Currently optimized for Go (with Fiber, Echo, Chi, Gin support). The output is a multi-file directory structure — one Markdown file per endpoint, grouped by handler domain — so each API is easy to find, review, and maintain independently.

Output Structure

docs/api/
├── index.md              ← service header, overview, endpoints table, common errors
├── <group>/
│   ├── <endpoint>.md     ← one endpoint per file
│   └── ...
└── ...
  • Grouping: each subdirectory under the handler base directory = one group
  • File naming: handler function name converted to kebab-case (e.g., AcceptConsentaccept-consent.md)
  • Path params in docs: always use {param} format in documented paths, regardless of framework syntax in code (:id{id}, {id} stays {id})
  • Index: docs/api/index.md links to every endpoint file
Related skills
Installs
11
GitHub Stars
2
First Seen
Mar 20, 2026