前后端接口通用规范

简介: 前言 前后端接口如何规范一直是一个问题,好的接口规范能让前后端合作更顺利。此文讨论一般的前后端接口规范。 前后端接口的必选参数 接口的版本号 用Version表示, 1.0 , 2.0等等,前端可以传递version=1.0来请求响应版本的接口。

前言

前端跟后端在进行接口制定的时候,

  1. 前端可以写统一的网络请求函数和数据返回处理函数。
  2. 前端可以对错误进行统一的处理和解析。

后端接口必须返回的字段

接口的版本号(version)

用Version表示, 1.0 , 2.0等等,前端可以传递version=1.0来请求响应版本的接口。

如何识别接口是否调用成功 (code)

借鉴http的状态码,前后端的接口规范辨别一个接口是否调用成功,最好也采用状态码来识别接口是否调用成功:
比如 200代表成功 4xx代表接口不存在, 5xx代表接口调用错误, 6xx代表参数错误等等
这个字段可以用code表示。

接口的主数据传递(data)

此字段用data表示。

服务端给用户的提示信息(msg)

当服务器出错的时候,需要提示给用户

服务端给开发人员的提示信息(subMsg)

出了给用户的信息提示,比如某些出错信息,有时候服务器的详细错误信息也需要展示出来~ 一般情况下这个消息并不会展示。
在交互上,可以由2种方式去展示这个错误

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

请求标识(queryId)

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

data字段详细说明

data作为后端返回的主数据,包含的东西比较多,特别返回的结果为数组的时候。

数组字段 list

当返回的结构为数组的时候,往往需要很多附加字段来做标识,所以数组的数据需要放在list里。

page: 页码

有分页的时候需要返回 ,在分页中,page的起页为1,而不能为0

pageSize 每页显示的数量

有分页的时候需要返回,

totalPage 总页数

数据的总页数,数据分页的时候需要返回。

totalCount 总数目

有时候前端需要返回数据的总数,这时候需要把总数返回来。

data: {
page: 1,
pageSize: 1,
list: [{},{}, {}]
}

需要把data预留为一个对象, 为了后期扩展page和pageSize.





目录
相关文章
|
测试技术
西门子S7-200 SMART自由口通信,如何编写发送程序,使用超级终端发送测试
今天我们学习编写西门子S7-200 SMART自由口通信的发送程序,并使用超级终端进行发送功能测试。首先设置参数,打开STEP7 Micro/WIN SMART编程软件,右键单击项目树中的CPU,选择打开,在打开的系统块中选择CPU类型和信号板类型。设置信号板,串口的类型为RS232,地址为2,波特率为9600。
西门子S7-200 SMART自由口通信,如何编写发送程序,使用超级终端发送测试
RS-485网络中的标准端接与交流电端接应用解析
RS-485,作为一种广泛应用的差分信号传输标准,因其传输距离远、抗干扰能力强、支持多点通讯等优点,在工业自动化、智能建筑、交通运输等领域得到了广泛应用。在构建RS-485网络时,端接技术扮演着至关重要的角色,它直接影响到网络的信号完整性、稳定性和通信质量。
|
3月前
【通信协议讲解】单片机基础重点通信协议解析与总结之SPI(二)
【通信协议讲解】单片机基础重点通信协议解析与总结之SPI(二)
|
3月前
【通信协议讲解】单片机基础重点通信协议解析与总结之IIC(一)
【通信协议讲解】单片机基础重点通信协议解析与总结之IIC(一)
|
3月前
|
网络协议 数据格式
【通信协议讲解】单片机基础重点通信协议解析与总结之ModBus(五)
【通信协议讲解】单片机基础重点通信协议解析与总结之ModBus(五)
|
5月前
|
网络协议
Tcp硬件设备数据规范
Tcp硬件设备数据规范
45 0
|
5月前
|
监控 开发工具 Android开发
结合GB/T28181规范探讨Android平台设备接入模块心跳实现
本文介绍了GB28181标准中的状态信息报送机制,即心跳机制,用于监控设备与服务器间的连接状态。根据国标GB/T28181-2016,设备在异常时需立即发送状态信息,在正常状态下则按固定间隔(默认60秒)定期发送。若连续三次(默认值)未收到心跳,则视为离线。文章展示了在Android平台的GB28181设备接入模块(SmartGBD)中,如何调整心跳间隔为20秒及超时次数为3次,并给出了心跳消息的示例和异常处理代码片段。对于希望深入了解或遇到问题的开发者,作者提供了进一步交流的机会。
GB28181控制、传输流程和协议接口之注册|注销和技术实现
注册和注销基本要求 SIP客户端、网关、SIP设备、联网系统等 SIP代理(SIP UA)使用IETFRFC3261中定义的方法 15 GB/T28181—2016Register进行注册和注销。
109 1
|
网络协议 Java API
慧安-PLC4X支持的协议
慧安-PLC4X支持的协议
316 0
|
存储 测试技术
西门子S7-200 SMART自由口通信,如何编写接收程序
本篇我们来学习编写西门子S7-200 SMART自由口通信的接收程序。我们继续使用上篇文中STEP7 Micro/WIN SMART编程软件所创建的项目,删除已经编写的发送程序,再来编写接收程序,拖动常开触点到程序段1中,输入地址SM0.1,通过传送指令,将常数十六进制数09送到SMB130。
西门子S7-200 SMART自由口通信,如何编写接收程序