API文档生成技能

概述

API文档生成技能是Claude Code的一个自动化技能，用于从源代码生成全面且准确的API文档。适用于创建或更新API文档、生成OpenAPI规范，或在用户提到API文档、端点或说明时使用。

关键内容

1. 可生成内容：
2. OpenAPI / Swagger 规范
3. API 端点文档
4. SDK 使用示例
5. 集成指南
6. 错误码参考

7. 认证指南

8. 文档结构：

9. 每个端点应包含描述、参数表格、响应格式
10. 提供详细的错误响应示例
11. 包含多种语言的调用示例（cURL、JavaScript、Python等）

12. 参数表格包含名称、类型、是否必填、说明等信息

13. 使用场景：

14. 生成API端点的完整文档
15. 创建SDK使用示例
16. 生成OpenAPI/Swagger规范文件
17. 提供多种编程语言的调用示例
18. 包含认证和错误处理指南

来源

• raw/assets/claude-howto/03-skills/doc-generator/SKILL.md — API文档生成技能的原始定义

相关

• API文档生成器 — 相关的API文档生成工具
• Skills — Claude Code技能系统
• API — 应用程序接口
• OpenAPI — API规范格式
• Swagger — API文档工具
• MCP Prompts — 相关提示技术

relates_to

relates_to: - target: "API文档生成器" type: implements confidence: 0.9 - target: "Skills" type: part_of confidence: 0.9 - target: "API" type: documents confidence: 0.95 - target: "OpenAPI" type: generates confidence: 0.85 - target: "Swagger" type: generates confidence: 0.85 - target: "MCP Prompts" type: uses confidence: 0.7