一 基本规范
1.1 公共请求参数
参数名称 | 说明 | 备注 |
---|---|---|
appVersion | APP的版本号 | 格式为:xx.xx.xx 例如:2.10.12 |
osVersion | 操作系统版本号 | 例如:13.3 |
firstChannel | 一级渠道 | 苹果/android/wap/微信小程序/支付宝小程序 |
secondChannel | 二级渠道 | 例如:华为/小米/OPPO/vivo/ |
deviceModel | 设备型号 | 例如:Meta20/Mi8/ 等 |
deviceToken | 设备唯一标示 | 例如:xxxxxxx-xxxxx-xxxx-xxxxxx-xxxxx |
1.2 URL规范
1.2.1 path路径格式
- https://域名/api/服务名/一级目录/二级目录/方法名
1.2.2 method方法规范
方法类型 | method | 备注 |
---|---|---|
查找 | GET | getXXX |
新增 | POST | createXXX/submitXXX |
修改 | POST | updateXXX |
删除 | POST | delXXX |
1.2.3 注意事项
- GET请求参数放在URL中传递,POST请求放在Body体中传递
1.3 字段命名规范
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
code | string | 返回结果码 | 成功:200 |
message | string | 显示提示信息 | 用户提示的信息 |
traceMessage | string | 跟踪信息 | 异常信息,错误信息堆栈跟踪 |
data | string | 数据实体 | 响应实体,JSON格式 |
- data采用JSON格式,数据列表对象建议携带list或者array后缀,便于前端识别解析
建议
- 使用String作为字段类型,容错性强
- 布尔类型使用特定字符转换,减少NULL判断
- 时间字段String展示
- 金额字段根据精度要求乘以100或者乘以1000把浮点数变为整数
三 安全性
3.1 数据安全性
- 响应数据用户的隐私数据要脱敏(例如:姓名/手机号/身份证号/住址)
- 关键请求参数用的敏感字段要加密处理(例如:登录密码/支付密码)
- 反爬监控与反爬策略
3.2 服务安全性
- 使用签名检验
- 黑白名单策略(基于IP,手机号,设备等)
- 限流降级策略
- 常规安全加固(SQL注入/XSS/CSRF等)
四 性能规范要求
4.1接口聚合
- 多个接口可以提供聚合接口一次请求完成数据加载避免多次接口请求引起不必要的网络消耗
4.2 网络检测
- WI-FI/4G调用的大流量接口,在3G网络下切换降级
4.3 兼容性
- 接口入参数采用对象传参
- 文案和提示信息支持动态配置
- 接口返回字段只能新增,不能修改和删除,类型也不能修改
- 新接口兼容老接口,老接口根据流量监控逐步淘汰