API接口文档生成助手

为什么需要它

写接口文档常常是开发流程里最容易被拖延的一环。你也许刚完成路由逻辑，却要回头在文档工具里手动敲下每一个字段的类型说明。不同接口的参数命名不统一，鉴权方式散落在各处的注释里，给前端或测试同学的示例请求也常常缺失。等到联调阶段，大家只能反复确认某个参数到底是 string 还是 number，或者某个响应体在出错时到底长什么样。

api-doc-generator 就是为了把这类重复且易错的文档工作交给 AI 完成。它关注的是把端点、代码逻辑快速转换成结构清晰的接口说明，而不是替你写业务代码。

它如何工作

• 从输入生成规范：贴入一段路由代码、接口描述或一组端点，技能会提取出路径、请求方法、参数定义、响应结构以及错误码，形成字段表。
• 补全示例与鉴权：在生成的文档里附带可直接复制的请求与响应示例，并统一说明鉴权方式，减少沟通成本。
• 支持 Markdown 与 OpenAPI：产出可以是一份可粘贴的 Markdown 文档，也可以是 OpenAPI 规范的草拟版本，方便后续导入到 Swagger UI 或其他文档站。
• 分步确认：你可以先把端点或代码贴给 AI，等它给出初步字段表和示例后，再逐项补充错误码或鉴权细节，最终得到一份完整可用的文档。

适用边界与注意点

• 本技能用于文档编写辅助，不能替代代码里的注释或类型推导工具。
• 不要把它生成的字段当作已实现的接口，仍需对照现有代码确认。
• 它不会主动读取你的代码仓库，仅基于你粘贴的内容进行整理。
• 红线：禁止把假设的字段当作真实接口，也不要在文档里写入真实的密钥或令牌。