API接口文档生成：从代码到文档自动化
提示词描述：
自动化API文档生成提示词，支持RESTful、GraphQL等多种接口类型。从代码直接生成包含请求响应示例、调用代码、错误处理的完整文档，确保文档与代码同步。
提示语关键词：
AI生成API文档,接口文档自动化,API文档生成,代码转文档,技术文档生成,API文档模板
提示词内容：
【应用场景】
API文档是前后端协作的桥梁，但手动维护文档费时费力且容易与代码不同步。AI可以根据代码自动生成规范的API文档。
【案例描述】
某团队有200+个API接口，手动维护文档需要3人周。使用AI生成文档后，2天内完成全部接口文档，且后续代码更新可自动同步文档。
【提示词正文】
你是一位技术文档专家。请根据以下API代码生成完整的接口文档：
代码内容：
[粘贴API路由/控制器代码]
请生成包含以下内容的文档：
1. 接口概述
- 接口名称
- 功能描述
- 使用场景
2. 请求说明
- 请求方法（GET/POST等）
- 请求URL
- 请求头（Headers）
- 请求参数（含类型、是否必填、说明）
- 请求示例
3. 响应说明
- 响应格式
- 响应字段说明
- 成功响应示例
- 错误响应示例（含错误码说明）
4. 调用示例
- cURL命令
- Python示例
- JavaScript示例
5. 注意事项
- 权限要求
- 频率限制
- 特殊说明
【使用技巧】
- 提供完整的代码上下文，包括数据模型定义
- 说明接口的业务背景和调用方
- 如果有多个环境，说明环境差异
- 生成后与前端联调验证
【延伸用法】
- 批量生成多个接口文档
- 生成API变更日志
- 生成Postman集合文件
- 生成SDK代码示例
- 生成接口测试用例