在一个新型的web应用中,由于中台只负责数据的输送,不涉及具体业务,所以就需要搭建一个业务服务来组装业务数据,把 浏览器/客户端 和中台连接起来。业务服务将组装完的数据以统一的数据格式返回给客户端,这里就需要对业务服务后台接口进行统一设计。下面就来具体介绍一下如何设计和编写后端接口。
0 统一规范
0.1 理清业务流程
通过需求文档,描述清楚业务流程,定义好相关的设计规范。根据项目大小划分好前台和后台的功能需求,通过需求来得到对应的模块。
0.2 定义前后端开发的接口规范
一般前后端分离项目会拥有不同的数据格式,例如 json、url等。 这里要通过文档的形式同前后端一起确定好数据阐述的格式。
接口地址:不包含接口BASE地址。
请求方式: get、post、put、delete等。
请求参数:数据格式(默认json)、数据类型、是否必填、中文描述。
响应参数:类型、中文描述。
0.3 定义接口文档
这里的接口文档一般就是对应后台的实体,即RequestVo(调用后台接口访问的实体)和给往前端的ResponseVo(前台调用接口时前往的实体)。一般来说ResponseVo都会在后台做一个统一的处理为ResultVo。
对于ResultVo的规范需要在上一节中定义好,例如:错误码Code,错误描述msg,请求的url,以及实体泛型T。
需要注意的是,这里定义的接口文档实在彻底了解号数据流、业务流的基础之上完成的。
尽量采用自动化接口文档,可以做到在线测试,同步更新。 文档中应包含:接口BASE地址、接口版本、接口模块分类等。
有了这个接口文档之后(