平台接口文档说明-API

荒凉一梦 提交于 2020-01-06 23:33:36

【推荐】2019 Java 开发者跳槽指南.pdf(吐血整理) >>>

1、【平台接口】通用响应数据结构说明

输出参数

字段 类型 必填 案例 说明
success boolean false 接口调用成功与否标识 true:成功,false:失败
code String -1 接口错误码标识 0:成功码,-1:失败码(通用型) ,-500:未知异常码
data Object [] 或 {} 接口响应数据
errorInfos Object [] 接口调用失败时,错误信息集
                   key String userName 错误信息的标识符
                   errCode String -S101 错误码
                   errMsg String 用户名不能为空 具体的错误信息
ext Object {} 接口响应数据(额外)

示例: 

{
  "success":false,
  "code":"-1",
  "data":{},
  "errorInfos":[
     {
       "key":"userName",
       "errCode":"-S101",
       "errMsg":"用户名不能为空"
     }
  ]
}                                                                                                                    

2、平台国际化

通过对请求头添加参数实现。默认为:简体中文

请求头属性 说明
Accept-Locale         en_US        英文:en_US               中文:zh_CN          

 

 

 

 

 

 

 

 

标签
易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!