RAP是什么
前后端协同开发其实就是个对接接口的过程,双方把接口定义好就可以各自开始coding了,谁也不用等谁,开发完了再一起联调。RAP是阿里内部使用的一个WEB接口管理工具,完全满足企业级的API管理应用,除了定义接口形成文档约定,还有MOCK数据的功能,最重要的是已经开源。
RAP能做什么
从官网给出的这张图,RAP可以做的不止是接口文档,但用户手册里面提到后端自测和校验工具Page Tester并不成熟,其实我根本没有找到这个功能,ISSUE里面有人问也没有回答。关于自动化测试,用户手册里面也说功能不成熟。所以RAP自带可用的功能,目前看就只有:
- 制定接口
- MOCK数据
如何使用RAP
对接口文档安全有要求且有条件的团体或个人,可以自己部署一个私有的RAP服务器,部署说明参考文档。
如果只是自己开发些DEMO,为了方便前端MOCK数据,可以使用官方维护的服务rapapi.org。注册过程很简单,只要有个邮箱就可以注册。成功登录后就来到主页了:
友情提醒:
我在rapapi.org首页上通过团队TAB看到了其他用户定义的团队和接口文档,所以你写的接口其他人应该也可以看到。
文档管理
RAP上支持对接口按照 团队
、业务线
、分组
三个层级管理。通过顶部导航栏“团队”TAB可以进行创建和切换。
下面我结合一个简单表格查询的例子说明开发时如何使用RAP编写接口和MOCK前端数据。
编写接口文档
可以看到同一个分组中还可以根据不同的模块,不同的页面管理接口文档。GUI操作界面使用方法简单清晰,我就不介绍怎么写文档了,参考用户手册。这里我定义了一个列表分页查询的API,按照接口文档定义我编写了下面的前端代码
<!--HTML部分-->
<div class="middle-content clearfix">
<el-table :data="list" highlight-current-row style="width: 100%;" border>
<el-table