API 文档生成器：用 AI 自动写出专业接口文档
提示词描述：
自动化 API 文档生成模板，输出符合行业规范的完整文档。包含参数说明、示例代码、错误处理等，适合快速交付专业级接口文档。
提示语关键词：
AI写API文档,接口文档生成,ChatGPT写文档,API文档模板,OpenAPI文档,自动生成文档
提示词内容：
【模板说明】
写完代码不想写文档？这个模板帮你自动生成符合 OpenAPI 规范的接口文档。从参数说明到示例请求，一站式搞定开发者最头疼的文档工作。
【使用场景】
前后端协作、开源项目维护、API 交付客户。当你需要快速产出专业文档又不想手动排版时，这个模板能节省 80% 时间。
【模板正文】
你是一个技术文档专家，精通 API 文档编写规范。请为以下接口生成完整文档：
接口功能：{填写接口用途，如"用户注册/获取订单列表/上传文件"}
请求方式：{填写 HTTP 方法，如"POST/GET/PUT"}
接口路径：{填写 URL 路径，如"/api/v1/users/register"}
请求参数：{填写参数列表，如"username(string), password(string), email(string)"}
响应格式：{填写返回数据结构，如"用户ID和token"}
请生成包含以下内容的文档：
1. 接口概述（一句话说明用途）
2. 请求说明（Headers/参数/示例）
3. 响应说明（成功/失败格式）
4. 错误码表（常见错误及处理）
5. 调用示例（cURL/Python/JavaScript）
6. 注意事项（限流/安全/版本）
【填写指南】
第一步：明确接口的核心功能
第二步：列出所有请求参数和类型
第三步：描述成功和失败的返回格式
第四步：补充特殊业务规则（如有）
【效果示例】
AI 会生成类似这样的文档：
```
# 用户注册接口
## 概述
创建新用户账户并返回认证 token
## 请求
POST /api/v1/users/register
Content-Type: application/json
### 参数
| 字段 | 类型 | 必填 | 说明 |
|----------|--------|------|--------------|
| username | string | 是 | 3-20位字符 |
| password | string | 是 | 8位以上 |
| email | string | 是 | 有效邮箱格式 |
### 示例
{
"username": "john_doe",
"password": "SecurePass123",
"email": "john@example.com"
}
## 响应
### 成功 (201)
{
"id": 123,
"token": "eyJhbGc..."
}
### 失败 (400)
{
"error": "EMAIL_EXISTS",
"message": "邮箱已被注册"
}
```