后端接口必须返回的字段
接口的版本号(version) 1.0 , 2.0 传递version=1.0来请求响应版本的接口。
如何识别接口是否调用成功 (code)
200代表成功
4xx代表接口不存在,
5xx代表接口调用错误,
6xx代表参数错误等等
接口的主数据传递(data)
数组字段 list 数组的数据需要放在list里。
page: 页码 有分页的时候需要返回 ,在分页中,page的起页为1,而不能为0
pageSize 每页显示的数量 有分页的时候需要返回,
totalPage 总页数 数据的总页数,数据分页的时候需要返回。
totalCount 总数目 有时候前端需要返回数据的总数,这时候需要把总数返回来。
服务端给用户的提示信息(msg)
当服务器出错的时候,需要提示给用户
服务端给开发人员的提示信息(subMsg)
- 通过代码把window.debug设置为
true的时候 - 前端提示信息组件可以把详细错误收起来,用户点击箭头的时候,再展示出来。
请求标识(queryId)
请求ID为当次请求的ID,为了让前端识别这是哪次请求返回的数据,这个id为前端发送,后端原样返回。
{
code: 200, 200: 请求处理成功500: 请求处理失败401: 请求未认证,跳转登录页406: 请求未授权,跳转未授权提示页
data: {
}
message: "success"
}
关于Boolean类型,JSON数据传输中一律使用1/0来标示,1为是/True,0为否/False;
关于日期类型,JSON数据传输中一律使用字符串,具体日期格式因业务而定

本文介绍了后端API设计中必须包含的关键字段,如版本号、状态码、数据体等,并详细解释了各字段的作用及常见返回值含义,适用于指导API的设计与调用。
2236

被折叠的 条评论
为什么被折叠?



