docs: 更新 DEV.md — 后端 API 响应格式规范
- 统一响应格式 { code: 0, data: ... }
- 错误码规范说明
This commit is contained in:
23
DEV.md
23
DEV.md
@@ -52,6 +52,29 @@ request('/config', { method: 'PUT', data })
|
||||
|
||||
**原因**:`request` 函数签名是 `request<T>(options: RequestOptions): Promise<T>`,第一个参数是 options 对象,不支持分开传 url 和 options。
|
||||
|
||||
### 后端 API 响应格式
|
||||
|
||||
**所有后端路由必须返回统一格式**:
|
||||
|
||||
```typescript
|
||||
// 成功
|
||||
res.json({ code: 0, data: ... })
|
||||
|
||||
// 失败
|
||||
res.status(400).json({ code: 40001, message: '错误信息' })
|
||||
res.status(403).json({ code: 40300, message: '无权限' })
|
||||
res.status(500).json({ code: 50000, message: '服务器错误' })
|
||||
```
|
||||
|
||||
**错误码规范**:
|
||||
- `0` — 成功
|
||||
- `40001` — 参数错误
|
||||
- `40300` — 权限不足
|
||||
- `40400` — 资源不存在
|
||||
- `50000` — 服务器错误
|
||||
|
||||
**原因**:前端 `request` 函数检查 `data.code === 0` 判断成功,不返回标准格式会导致前端误判为失败。
|
||||
|
||||
### 页面数据加载模式
|
||||
|
||||
```typescript
|
||||
|
||||
Reference in New Issue
Block a user