|
|
@@ -85,6 +85,11 @@ getJSON("http://rap.taobao.org/mockjs/9768/Rap/get").then(function(response) {
|
|
|
- `503 Service Unavailable`：服务器无法处理请求，通常用于网站维护状态
|
|
|
|
|
|
## 参数约定
|
|
|
+* 请求参数和返回参数字段名统一使用首字母小写的驼峰格式
|
|
|
+* 返回的字段值数据类型要保持和数据库的数据类型一致，如字符串返回的json格式需要用双引号将内容包含起来，而数值类型的不需要。
|
|
|
+* 除对象实体外，其他类型不允许返回`null`。
|
|
|
+* 时间类型的数据后端要将时间戳转换为可读格式，后端WEB可用的格式有`Y-M-d H:i:s`，`Y-M-d H:i`，`Y-m-d`，如对时间无特殊要求，默认为`Y-M-d H:i`，即精确到分即可。
|
|
|
+
|
|
|
### 请求参数约定
|
|
|
__常用的请求参数必须使用下表约定的字段，不允许自定义。__
|
|
|
|
|
|
@@ -94,7 +99,7 @@ __常用的请求参数必须使用下表约定的字段，不允许自定义。
|
|
|
| 分页大小 | size | int | 默认值为20，最大不能超过100 |
|
|
|
| 性别 | gender | string | male=男，female=女 |
|
|
|
| 模糊搜索关键字 | keywords | string | 仅针对同时支持多个字段模糊检索的，如同时从商品名称和商品详情中搜索的字段 |
|
|
|
-| 身份证号 | id_card | string | 特指中国大陆身份证号，前端对输入的身份证号要进行规则校验 |
|
|
|
+| 身份证号 | idCard | string | 特指中国大陆身份证号，前端对输入的身份证号要进行规则校验 |
|
|
|
| 手机号 | mobile | string | 特指中国大陆手机号（支持加+86），前端对输入的手机号要进行规则校验 |
|
|
|
| 电话号码 | telephone | string | 包括手机号，400，800，955xx，100xx，固定电话等号码，前端要对表单数据进行规则校验 |
|
|
|
| 姓名 | name | string | 真实姓名 |
|
|
|
@@ -103,7 +108,7 @@ __常用的请求参数必须使用下表约定的字段，不允许自定义。
|
|
|
| 验证码 | captcha | string | 包括短信验证码，输入校验验证码 |
|
|
|
| 经度 | longitude | float | 精确到小数点后6位小数 |
|
|
|
| 纬度 | latitude | float | 精确到小数点后6位小数 |
|
|
|
-| 唯一编号 | __实体名___id | int | 如用户编号，使用user_id，分类编号使用category_id |
|
|
|
+| 唯一编号 | __实体名Id | int | 如用户编号，使用userId，分类编号使用categoryId |
|
|
|
|
|
|
### 返回格式约定
|
|
|
返回数据遵循ES6的规范，前端能够通过返回数据构建`Promise`对象进行处理，统一采用`JWT`做鉴权，`JWT`的访问令牌`token`通过`HTTP Header`返回。
|
|
|
@@ -123,17 +128,17 @@ __常用的返回参数必须使用下表约定的字段，不允许自定义。
|
|
|
data: {
|
|
|
user: {
|
|
|
id: 1,
|
|
|
- real_name: "root",
|
|
|
- gender_txt: "女士",
|
|
|
- staff_code: "96582",
|
|
|
- last_logined_endpoint_txt: "网站",
|
|
|
- last_logined_at: {
|
|
|
+ realName: "root",
|
|
|
+ genderText: "女士",
|
|
|
+ staffCode: "96582",
|
|
|
+ lastLoginedEndpointText: "网站",
|
|
|
+ lastLoginedAt: {
|
|
|
date: "2018-12-26 11:21:40.000000",
|
|
|
- timezone_type: 3,
|
|
|
+ timezoneType: 3,
|
|
|
timezone: "Asia/Shanghai"
|
|
|
},
|
|
|
- staff_status_txt: "在职",
|
|
|
- account_status_txt: "正常"
|
|
|
+ staffStatusText: "在职",
|
|
|
+ accountStatusText: "正常"
|
|
|
}
|
|
|
}
|
|
|
}
|
|
|
@@ -146,18 +151,18 @@ __常用的返回参数必须使用下表约定的字段，不允许自定义。
|
|
|
data: [
|
|
|
{
|
|
|
id: 10,
|
|
|
- residence_name: "in placeat",
|
|
|
- residence_logo: null,
|
|
|
- buildings_count: 0,
|
|
|
- units_count: 0,
|
|
|
- houses_count: 0,
|
|
|
- householders_count: 0
|
|
|
+ residenceName: "in placeat",
|
|
|
+ residenceLogo: "",
|
|
|
+ buildingsCount: 0,
|
|
|
+ unitsCount: 0,
|
|
|
+ housesCount: 0,
|
|
|
+ householdersCount: 0
|
|
|
}
|
|
|
],
|
|
|
meta: {
|
|
|
- current_page: 1,
|
|
|
+ currentPage: 1,
|
|
|
from: 1,
|
|
|
- last_page: 1,
|
|
|
+ lastPage: 1,
|
|
|
size: 10,
|
|
|
to: 1,
|
|
|
total: 1
|
|
|
@@ -172,7 +177,7 @@ __常用的返回参数必须使用下表约定的字段，不允许自定义。
|
|
|
|:-------------:|:----------:|:---------:|:----------------------------|
|
|
|
| 就绪状态 | readyState | int | 4=已就绪，服务端已完成响应 |
|
|
|
| 请求状态码 | status | int | 参考http状态码返回 |
|
|
|
-| 状态码描述 | statusTest | String | http状态码返回对应的英文描述，如Unauthorized, Bad Request等 |
|
|
|
+| 状态码描述 | statusText | String | http状态码返回对应的英文描述，如Unauthorized, Bad Request等 |
|
|
|
| 响应JSON数据 | responseJSON | Object | 响应JSON数据，其中必须包含message字段，标识错误提示信息 |
|
|
|
|
|
|
示例数据如下：
|
