J10中级
API 文档写作
45 分钟每个新 API
格式:为一个 API 端点写文档。
模板:
## 创建用户
`POST /api/v1/users`
### 描述
创建一个新的用户账户。
### 请求参数
| 参数 | 类型 | 必填 | 描述 |
|------|------|------|------|
| email | string | 是 | 用户邮箱 |
| password | string | 是 | 密码(>=8字符) |
| name | string | 否 | 用户显示名 |
### 成功响应 (201)
```json
{ "id": "123", "email": "user@example.com", "name": "小明" }
错误响应
| 状态码 | 描述 |
|---|---|
| 400 | 邮箱格式不正确 |
| 409 | 邮箱已被注册 |
| 500 | 服务器内部错误 |
示例
curl -X POST https://api.example.com/v1/users \
-H "Content-Type: application/json" \
-d '{"email":"user@example.com","password":"secure123"}'