初始化
This commit is contained in:
41
.cursor/skills/api-scaffold/references/api-response.md
Normal file
41
.cursor/skills/api-scaffold/references/api-response.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# API 统一响应格式
|
||||
|
||||
## 成功响应
|
||||
|
||||
```json
|
||||
{
|
||||
"data": { ... },
|
||||
"meta": {
|
||||
"page": 1,
|
||||
"pageSize": 20,
|
||||
"total": 100,
|
||||
"totalPages": 5
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 错误响应
|
||||
|
||||
```json
|
||||
{
|
||||
"error": "Human-readable error message",
|
||||
"code": "VALIDATION_ERROR",
|
||||
"details": [ ... ]
|
||||
}
|
||||
```
|
||||
|
||||
## HTTP 状态码
|
||||
|
||||
| 状态码 | 场景 |
|
||||
|--------|------|
|
||||
| 200 | 查询/更新成功 |
|
||||
| 201 | 创建成功 |
|
||||
| 204 | 删除成功(无响应体) |
|
||||
| 400 | 请求参数验证失败 |
|
||||
| 401 | 未认证 |
|
||||
| 403 | 已认证但无权限 |
|
||||
| 404 | 资源不存在 |
|
||||
| 409 | 资源冲突(如重复创建) |
|
||||
| 422 | 业务逻辑错误 |
|
||||
| 429 | 请求频率超限 |
|
||||
| 500 | 服务器内部错误 |
|
||||
Reference in New Issue
Block a user