本文档约定了服务开发人员的代码规范,从而增强代码的一致性和可维护性
1、接口地址和参数严格区分大小写,接口尽量全部小写,参数使用驼峰命名;
2、接口默认以请求参数形式传入参数,响应返回JSON格式数据;
3、H5内所有资源引用打包自动带上日期版本号,防止发布版本引用资源在浏览器缓存导致功能异常(如:./jquery-1.11.0.js?v=201806051011)
4、接口请求数据均需要携带header参数:
参数名 | 必填 | 类型 | 说明 |
---|---|---|---|
x-auth-scope | 是 | string | 授权作用域 |
x-auth-token | 是 | string | 授权的token |
x-app-version | 是 | string | 应用版本(固定 1.0.0) |
x-device | 是 | integer | 设备类型(1:IOS 2:Android 3:wap 4: 微信 5: H5) |
x-device-name | 是 | string | 设备/浏览器名称(如:huawei/Chrome) |
x-timestamp | 是 | long | 10位时间戳 |
5、接口返回数据JSON格式标准:
- 正常状况下返回http状态码为200
- 异常或相关提示是http状态码大于等于400
- 业务异常时http状态码为400,系统故障时http状态码为500
- 正常状况下接口直接返回业务数据(void时返回空)
- 异常时返回错误码和错误信息(JSON格式)
参数名 | 类型 | 说明 |
---|---|---|
code | integer | 错误码 |
msg | string | 错误信息 |
带返回数据示例:
1 | { |
异常返回示例:
1 | { |