用途:从源代码扫描生成或校验 API 文档,当前针对 Go 语言,支持 Fiber、Echo、Chi、Gin 框架。输出为多文件目录结构,每个端点一个 Markdown 文件,按 handler 域分组,便于查找与维护。
输出结构:docs/api/ 下含 index.md(服务头、概览、端点表、常见错误)与各分组子目录;每个子目录对应一个分组,文件名由 handler 函数名转为 kebab-case(如 AcceptConsent → accept-consent.md);文档路径参数统一用 {param} 格式。
三种模式:Generate(无 docs/api/ 时从头生成)、Update(index.md 存在且代码有变时增量增删改并重建索引)、Validate(对比文档与代码,只报告差异不修改)。模式可自动判断,也可由用户显式指定。
工作流:先读 CLAUDE.md/AGENTS.md/CONTRIBUTING.md 获取项目上下文,再扫描路由注册、handler 目录分组,随后从 handler→usecase→repository 提取请求/响应结构、成功状态码、业务逻辑步骤、错误映射、鉴权类型与校验规则。业务逻辑优先采用 usecase 头部注释中的 Step N 行,否则按代码推导计数规则统计步骤。
确定性文本规则:端点描述、显示名、字段描述、业务步骤措辞、索引概览段落均有固定公式,以保证多次运行输出一致。字段 M/O 分类依据 Go 结构体标签(binding/validate required、指针类型、omitempty、bool 默认值等)判定。
完整性要求:字段表须与代码结构体 1:1 对应,含嵌入结构体、自定义类型、嵌套对象与数组;错误表须覆盖 usecase 与 domain service 中所有类型化错误及 handler 级错误,并映射到 HTTP 状态码。
限制:当前仅优化 Go 语言;其他语言、具体安装命令、收费与平台信息暂未提供。