# 项目简介
MoChat, easy way to WeWork
MoChat 项目后端接口文档,目前有 PHP 和 Java 版本,各语言对应的接口规范和格式一致。
# 认证方式
目前所有的接口使用 JWT Authorization Bearer header 进认证。
# 响应参数字段说明
| 字段 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| code | Number | 必填 | 错误码 |
| msg | String | 必填 | 具体描述 |
| data | String[] | 必填 | 数据 |
# 响应示例
{
"code": 200,
"msg": "成功",
"data": []
}
# 分页参数
# GET 之后所有的列表接口参数,将只针对 list 进行具体说明
# 请求参数字段说明
| 字段 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| page | Number | 必填 | 页码 |
| perPage | Number | 必填 | 每页显示条数 |
# 响应参数字段说明
| 字段 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| page | Object | 必填 | 页码 |
| page.perPage | Object | 必填 | 每页条数 |
| page.total | Number | 必填 | 总条数 |
| page.totalPage | Number | 必填 | 总页数 |
| list | String[] | 必填 | 分页数据 |
# 响应示例
{
"page": {
"perPage": 10,
"total": 100,
"totalPage": 10
},
"list": []
}