api-documentation-generator

此 API 文档生成器是专为软件工程师与技术撰稿人所设计的专业技能，旨在维护即时、机器可读且符合人类阅读习惯的 API 参考文档。通过分析您的代码库，此代理程序能自动处理编写端点说明、参数定义与响应架构的繁琐工作，确保整个项目文档的一致性。对于采用 API 优先开发流程的团队，或是需要整合后端实现与前端应用的开发者而言，这是一项不可或缺的工具。

• 从控制器代码、路由与模型定义中自动生成 OpenAPI 与 Swagger 2.0/3.0 规范。

• 创建包含路径参数、查询字符串、标头与请求主体的标准化端点文档。

• 提供结构化的响应示例，包含成功 (200 OK) 输出及常见错误场景 (404, 401, 500 等)。

• 生成适用于多种编程语言的 SDK 使用示例，包括 cURL、JavaScript (Fetch) 与 Python (Requests)。

• 根据应用程序中定义的安全性协议，产出完整的集成与验证指南。

• 协助建立错误代码参考表与状态码说明。

• 输入需求：当提供源代码存储库、控制器文件或特定路由定义作为上下文时，此技能的效果最佳。

• 集成建议：特别是在修改后端逻辑后，通过交互式会话中的斜线指令调用，能发挥极高效率。

• 最佳实践：在 PR 审查期间使用此工具，确保文档能与功能开发同步。产出的内容遵循严格的 Markdown 结构，可直接嵌入 Wiki、README 文件或专用的文档门户网站。

• 限制：文档产出的精确度取决于代码本身的清晰度。建议配合描述性的 JSDoc 或 Python Docstrings 使用，以最大化端点说明的质量。