前后端接口通用规范

简介: 前言 前后端接口如何规范一直是一个问题,好的接口规范能让前后端合作更顺利。此文讨论一般的前后端接口规范。 前后端接口的必选参数 接口的版本号 用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.





目录
相关文章
|
6月前
|
运维 网络协议 数据中心
SFP 端口:连接世界的通用接口
【4月更文挑战第21天】
439 0
SFP 端口:连接世界的通用接口
|
测试技术
西门子S7-200 SMART自由口通信,如何编写发送程序,使用超级终端发送测试
今天我们学习编写西门子S7-200 SMART自由口通信的发送程序,并使用超级终端进行发送功能测试。首先设置参数,打开STEP7 Micro/WIN SMART编程软件,右键单击项目树中的CPU,选择打开,在打开的系统块中选择CPU类型和信号板类型。设置信号板,串口的类型为RS232,地址为2,波特率为9600。
西门子S7-200 SMART自由口通信,如何编写发送程序,使用超级终端发送测试
RS-485网络中的标准端接与交流电端接应用解析
RS-485,作为一种广泛应用的差分信号传输标准,因其传输距离远、抗干扰能力强、支持多点通讯等优点,在工业自动化、智能建筑、交通运输等领域得到了广泛应用。在构建RS-485网络时,端接技术扮演着至关重要的角色,它直接影响到网络的信号完整性、稳定性和通信质量。
|
11天前
|
传感器 安全 Java
如何使用 CoAP 协议进行设备通信
CoAP(Constrained Application Protocol)是一种适用于资源受限设备的轻量级协议,常用于物联网(IoT)设备之间的通信。本文介绍如何使用 CoAP 协议进行设备通信,包括协议的基本概念、消息格式、请求与响应流程以及实际应用示例。
|
1月前
【通信协议讲解】单片机基础重点通信协议解析与总结之SPI(二)
【通信协议讲解】单片机基础重点通信协议解析与总结之SPI(二)
|
1月前
|
网络协议 数据格式
【通信协议讲解】单片机基础重点通信协议解析与总结之ModBus(五)
【通信协议讲解】单片机基础重点通信协议解析与总结之ModBus(五)
|
1月前
【通信协议讲解】单片机基础重点通信协议解析与总结之串口通信(三)
【通信协议讲解】单片机基础重点通信协议解析与总结之串口通信(三)
|
1月前
【通信协议讲解】单片机基础重点通信协议解析与总结之IIC(一)
【通信协议讲解】单片机基础重点通信协议解析与总结之IIC(一)
|
1月前
|
IDE 开发工具
【通信协议讲解】单片机基础重点通信协议解析与总结之CAN(四)
【通信协议讲解】单片机基础重点通信协议解析与总结之CAN(四)
|
2月前
|
传感器 监控 网络协议
modbus协议的定义-钡铼技术
Modbus协议是一种广泛应用于工业自动化和控制系统中的开放通信协议,由Modicon公司于1979年发布。该协议定义了消息结构,支持RS232、RS485和TCP/IP等多种电气接口和传输介质,具备开放性、简单性和适应性强等特点。Modbus采用主从通信模式,支持ASCII、RTU和TCP三种传输模式,确保数据传输的可靠性和准确性。其主要作用包括设备通信、监控与控制以及提供标准化接口,简化系统集成并适用于多种应用场景。