接口技术规范

如果你是一名前端工程师或者后端程序员，在为约定前后端接口而伤神，可以参考！

目前推出规范 A 、 B 方案，简述如下：

A方案

接口基于 REST 规则，好处多多，原则是：客户端和服务器之间的交互在请求之间是无状态的。从客户端到服务器的每个请求都必须包含理解请求所必需的信息。如果服务器在请求之间的任何时间点重启，客户端不会得到通知。此外，无状态请求可以由任何可用服务器回答，这十分适合云计算之类的环境。客户端可以缓存数据以改进性能。

少管理URL，通常一个实体的增删改查，给4个接口，命名上也烦心不少：edit、update、new、add、detail ... 哎!

通过响应码提前就做分支处理，没必要接收到 response 再做！系统分层！

B方案

相对于A方案，一个事务需要建立一个URL。

响应码是基于 200，对于所有错误检测、调试与反馈是通过 response 中 success、errorCode、errorFields 来完成。

前言

A、B方案中文档目录：

• 0 索引
• 1.0 关键点【必看】：指该方案的核心原则，即如何定义URL、有效性判断、实体字段定义、接口文档书写等
• 2.0 实体定义【必看】：详细说明定义实体字段、格式、关联、类型
• 3.0 通用响应格式【必看】：说明当接口错误时返回的结构、字段
• 4.1-4.5 ：列举常见应用场景下的接口定义实例
• 5.0【必看】：业务系统在常见校验规则未通过时，显示统一的信息，即当 success :false 时，message 显示给用户的格式