前后端混合开发:
沟通成本比较高。
分工不明确。
不便管理,不便于后期的维护和拓展。
前后端分离开发:
当前主流的开发模式:前后端分离开发:
接口文档:
接口并不是interface。
接口指的是业务功能。
添加员工是一个业务功能,称为一个接口,删除员工是一个功能,也是一个接口。
一个业务功能,就是一个接口。
接口文档示例:
请求路径、请求方式、基本描述信息、请求参数、参数含义、请求样例。
响应数据返回的格式是JSON格式。
JSON中每项数据的含义是什么?最终数据大概是什么样子。
接口文档有了,前后端工程师阅读接口文档,根据接口文档进行开发。
接口文档中定义了需要传递什么参数,前端工程师给后端在请求中传递什么参数就可以了。
后端工程师也是根据接口文档描述的形式,来接收参数,后端处理完成,再按照接口文档所描述的规范给前端响应对应的数据。
前端工程师再根据响应数据进行解析。
前端工程师和后端工程师都严格遵循了接口文档,前端工程师和后端工程师可以无缝衔接在一起的。
接口文档怎么进行维护呢?
在线方式:
接口在线管理平台:
离线:
word、excel、markdown中定义接口。
接口文档是由谁来定义的呢?依据什么定义的?
产品经理是由产品原型、需求分析分析而来的。
原型什么样子的?
在页面原型中,就详细地描述了我们要做什么功能。每个功能要做成什么样子的,界面显示什么信息?界面中有哪些功能,以及每个功能的描述、需求说明中都有详细的描述。
那么我们根据这个页面原型和需求文档,就能得到接口文档。
开发流程:
需求分析:
接口文档:API接口文档
前后端并行开发:遵守规范
测试:前端、后端
前端和后端的联调测试
接口文档的管理平台:
YAPI:
介绍:YApi是一款高效、易用、功能强大的api管理平台,旨在为开发、产品、测试人员提供更优雅的接口管理服务。
可以在公司内部进行部署,供自己公司内部使用。
YApi主要提供两个功能:
1)api接口管理功能;
2)Mock服务:模拟真实接口,生成接口的模拟数据,用于前端功能测试。前后端就可以并行开发。后端人员还没有开发完成,前端人员可以先使用mock提供的地址进行模拟测试。
YApi平台:
添加项目
添加分类:
添加接口
Mock地址:
高级Mock配置期望返回的数据。