接口全局设置
应用采用前后端分离的架构,前端和后台通过http协议进行交互
- 数据协议: http(s)
- 请求类型: post
- 数据格式: json
- request数据框架
{
"header":{
"requestId":"请求编号",
"ip":"客户端IP地址",
"timestamp":"请求时间",
"applicationId":"客户端应用名称",
"tokenId":"登录后的token" //登录后将获得token, 业务接口都需要传入token,部分公共接口不需要传入
},
"body": {
... //业务数据,下面接口描述中的数据只描述该部分
}
}
- response数据框架
{
"header":{
"requestId":"请求编号",
"ip":"客户端IP地址",
"timestamp":"请求时间",
"applicationId":"客户端应用名称",
"tokenId":"登录后的token"
},
"body": {
"status": {
"statusCode":"0代表接口业务处理正常",
"errorCode":"statusCode不为0时返回的错误代码",
"statusCode":"statusCode不为0时返回的错误描述"
},
... //业务数据,下面接口描述中的数据只描述该部分
}
}