Prompt：API 文档生成

适用场景

写好了 API 接口，需要生成文档给前端或其他开发者看。不想手动写文档，直接从代码生成。

模板正文

请根据以下 API 代码/设计，生成 API 文档。

API 类型：【REST / GraphQL / WebSocket】
代码或接口定义（粘贴代码或接口描述）：

【粘贴代码或接口路由定义】

请按以下格式生成文档：

## 接口名称

**URL：** `POST /api/xxx`

**描述：** 一句话说清楚这个接口做什么

**请求参数：**
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| xxx    | string | 是 | xxx |

**请求示例：**
```json
{
  "xxx": "value"
}

响应参数：

参数名	类型	说明
code	int	状态码
data	object	返回数据

响应示例：

{
  "code": 200,
  "data": {}
}

错误码：

错误码	说明
400	参数错误
401	未授权

注意事项：

• 频率限制
• 权限要求
• 其他注意点

  ## 使用示例
  
  **输入（Express.js 代码）：**
  
  ```javascript
  router.post('/api/users', async (req, res) => {
    const { name, email } = req.body;
    const user = await User.create({ name, email });
    res.json({ code: 200, data: user });
  });

输出：

创建用户

URL： POST /api/users

描述： 创建新用户

请求参数：

参数名	类型	必填	说明
name	string	是	用户名
email	string	是	邮箱地址

响应示例：

{
  "code": 200,
  "data": {
    "id": 1,
    "name": "张三",
    "email": "test@example.com"
  }
}

小提示

• 好的 API 文档让前端少找你问 10 次
• 请求/响应示例比参数表格有用
• 标注”注意事项”比事后解释高效