这两天看到知乎上的:后端开发完接口才给出接口文档,合理吗?引起了不少的讨论,说起来这是前后端分离普及之后带来的一个新问题,阿里妈妈前端团队比较早在业务中全面使用单页应用,对接口管理有过一些探索和积累,最后搞出了一套贯穿【后端代码 -> 接口测试 ->接口文档 -> Mock -> 前端代码与类型】全开发流程的接口解决方案,在集团(6000+阿里开发者)和社区(1w+ stars)都有广泛的使用,这里再和大家分享一下~
前后端分离带来的变化
前后端分离其实意味着:项目的分离、开发周期的分离和开发人员的分离。
我们接到一个需求,开始项目排期,前端和后端分属两个人开发,产品经理打死也不会同意前端刷着知乎等到后端开发完接口、产出文档之后再介入开发,一定是双方并行开发最后再联调的。
在两不相见的之前,提前产出的一份接口约定可以说是必需的,不然很容易就促成联调驱动开发,项目进度一拖再拖的惨案。
除了一份接口文档,前后端分离后:
对于前端,我们需要一份准确的 Mock 数据,能够让项目摆脱后端独立运行;
对于后端,我们写起接口文档有点麻烦,最好能简化,需要能自行发起 API 请求测试接口可用性;
一次录入,多次使用,接口管理就是一把梭
我们用一个接口管理工具 Rap (http://rap2.taobao.org/) 来把这些需求一把梭解决,它大概长成下面这个样子:
Rap 可以按照团队、仓库、模块来管理细碎的接口,新建一个接口可以很轻松&