# 通用說明
## 一、請求
1、api接口都帶有api的路徑
例如:http://www.xxxxx.com/api/user
2、請求頭必須帶有如下信息
Content-Type:application/json
3、請求體使用json格式
## 二、返回格式說明
| 名稱 | 意義 | 補充 |
| --- | --- | --- |
| status | 返回狀態 | `success`:成功,`error`:錯誤 |
| data | 數據 | 當`status`\=`success`時返回 |
| error | 錯誤 | 當`status`\=`error`時返回 |
| error.message | 錯誤內容 | |
| error.code | 錯誤編號 | |
success實例
```
{
"status": "success",
"data": {
"demo":"demo"
}
}
```
error實例
```
{
"status": "error",
"error": {
"message": "沒有登錄",
"code": 0
}
}
```
## 三、特殊情況
默認情況下接口響應的`status code`是200
如果不是200 也表示接口存在問題
## 四、加密
1、id加密
涉及到id都會進行hash混淆加密, 所以id類型的屬性都是字符串的
線下調試為了方便,通過`debug`字符串的前綴表示hash混淆加密