AI写API接口文档，程序员再也不怕沟通难题
提示词描述：
后端开发者的API文档生成神器，用AI快速生成专业规范的接口文档。从请求参数到响应格式，从错误处理到调用示例，让你的API文档既专业又易懂，大幅提升团队协作效率。
提示语关键词：
AI写API文档,接口文档生成,ChatGPT编程,API提示词模板,后端开发,RESTful文档
提示词内容：
【使用场景】
做后端开发的朋友，你是不是经常因为API文档写得不清楚，跟前端同事扯皮？或者接手别人的项目，看到一堆乱七八糟的接口文档就抓狂？今天教你用AI生成专业的API文档，让团队协作更顺畅。
【文档结构模板】
```
接口名称：{功能描述}
请求方式：{GET/POST/PUT/DELETE}
请求路径：{/api/xxx}
请求参数：
| 参数名 | 类型 | 必填 | 说明 | 示例值 |
|--------|------|------|------|--------|
| {字段} | {类型} | {是/否} | {说明} | {示例} |
响应格式：
{
"code": 200,
"message": "success",
"data": {
{字段说明}
}
}
错误码：
| 错误码 | 说明 |
|--------|------|
| 400 | {错误描述} |
| 500 | {错误描述} |
调用示例：
{代码示例}
```
【操作步骤】
第一步：描述接口功能
```
我要写一个{功能}的API接口，用于{业务场景}
```
第二步：提供技术细节
```
技术栈：{框架}
数据库表：{表结构}
业务规则：{逻辑说明}
```
第三步：指定文档要求
```
文档要求：
- 遵循{OpenAPI/Swagger}规范
- 包含{认证方式}说明
- 提供{多种语言}调用示例
```
【实战案例】
需求：用户登录接口
提示词：
```
写一个用户登录API文档
技术栈：Spring Boot + MySQL
业务规则：
- 用户名或邮箱登录
- 密码加密验证
- 返回JWT token
- 登录失败记录错误次数
要求：
- 符合RESTful规范
- 包含完整的请求/响应示例
- 提供curl和Python调用示例
```
【对比分析】
❌ 普通文档：
"登录接口，传用户名密码，返回token"
✅ AI生成文档：
- 完整的参数说明和类型定义
- 多种错误场景的处理说明
- 多语言调用示例
- 安全注意事项
【进阶技巧】
1. 批量生成：让AI根据数据库表结构批量生成CRUD接口文档
2. 版本管理：告诉AI"这是v2版本，对比v1的变更点"
3. 自动生成Mock数据："为这个接口生成测试用的Mock数据"
【注意事项】
1. 敏感接口要注明权限要求
2. 复杂业务逻辑要画流程图辅助说明
3. 定期让AI检查文档与代码的一致性