[TOC]
## API接口規范
### 消息規范
系統使用統一的消息返回機制,所有的API返回JSON數據,格式一致。如果所請求的API需要授權,而用戶沒有獲得授權,直接拋出HTTP:401錯誤,客戶端檢測到401狀態直接跳轉到登錄頁面進行授權。
```json
{
errno: 1000,
errmsg: '錯誤消息',
data: {}
}
```
| 字段 | 含義 | 說明 |
| ------ | ------ | ------ |
| errno | 錯誤代碼 | 通常返回 0,表示請求正常返回接口數據;如果請求出錯,返回具體的錯誤代碼,并在data字段返回錯誤的附加信息 |
| errmsg | 錯誤消息 | 返回數據的解釋性描述文字 |
| data | 返回的業務數據 | 一般返回JSON對象或者 JSON數組格式,如果返回的是分頁數據還要包含分頁的信息 |
### 錯誤代碼
| 錯誤代碼 | 含義 | 說明 |
| ------ | ------ | ------ |
| 0 | 正常返回 | 請求的接口正確的返回業務數據,非0表示請求出錯 |
| 1000 | 一般錯誤 | 通用的錯誤代碼 |
| 1001 | 請求接口參數校驗錯誤 | 參數格式、類型不正確等 |