api-doc-generator

API Doc Generator 是一款专为开发者与软件工程师设计的专业 AI 技能，旨在简化 API 技术文档的编写流程。通过直接分析源代码，此工具能精确识别 API 模式、参数、数据结构与认证机制，并将其转换为结构化且易于阅读的文档。它对于使用 FastAPI、Express 或任何公开 API 端点的开发框架特别有效，能协助团队在无需手动维护的情况下，确保规格文档的实时更新。

• 自动解析代码库，提取端点路径、HTTP 方法及请求与响应结构。
• 支持多种 API 风格，包括 REST、GraphQL 及基于 RPC 的接口。
• 支持多种输出格式：适合内部文档的 Markdown、用于生态系统兼容的 OpenAPI 3.0 (Swagger) 及 API Blueprint。
• 具备标准化模板系统，确保不同项目间文档风格的一致性。
• 识别关键 API 元数据，如 OAuth、JWT 及 API Key 认证架构。

此技能适用于需要在开发周期中生成文档的后端工程师、DevOps 工程师与技术写作者。使用时，只需提供包含 API 端点的源代码，AI 即会分析代码逻辑、推断类型与参数，并输出清晰格式化的结果。建议代码中包含 Docstrings 或类型提示，以提升生成文档的精确度与深度。输出的文档针对可读性进行了优化，提供包含路径、查询与请求体参数的清晰表格，以及示例请求与响应。这是自动化 API 规格管理、辅助 CI/CD 流程或日常开发工作的强大工具。