# 通用说明
## 一、请求
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混淆加密
