前后端接口规范

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

后端接口必须返回的字段

接口的版本号(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)

  1. 通过代码把window.debug设置为true的时候
  2. 前端提示信息组件可以把详细错误收起来,用户点击箭头的时候,再展示出来。

请求标识(queryId)

请求ID为当次请求的ID,为了让前端识别这是哪次请求返回的数据,这个id为前端发送,后端原样返回。

{
code: 200, 200: 请求处理成功500: 请求处理失败401: 请求未认证,跳转登录页406: 请求未授权,跳转未授权提示页
data: {     
    }
message: "success"
}

关于Boolean类型,JSON数据传输中一律使用1/0来标示,1为是/True,0为否/False;

关于日期类型,JSON数据传输中一律使用字符串,具体日期格式因业务而定

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

东宇科技

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值