我的新书《Android App开发入门与实战》已于2020年8月由人民邮电出版社出版,欢迎购买。点击进入详情
文章目录
- 简介
- postman
简介
在开发过程中涉及到前端和后台的交互,那就是api接口。
前端的需求是api接口定义好以后,能够有数据返回,有了数据后前端便于开发调试;而接口的数据是后台开发的任务,往往不能够短时间内完成。这样前端和后台就会有一个时间差,前端需要数据调试UI,而后台数据需要开发。
这种情况下,前端开发的时候往往会造一些假数据,方便自己开发调试,等后台有了数据后再将假数据删除,重新接入URL进行测试。
这种开发的弊端是:
- 需要本地模拟数据,后期需要删除模拟数据,这种操作会带来一定的工作量,并且还有误操作可能;
- 前端和后台的api接口基于wiki文档。在api定义好后,如果有变更,则需要修改wiki文档,而且其他端并不能及时通知到,会增加一定的沟通成本;
- 如果api接口有变更,前端的模拟数据也需要做出调整。
我们希望达到的效果是:
- 前端和后台使用同一个api协同管理系统,api定义好之后各端可以不依赖彼此各自并行开始工作;
- api管理系统里面定义各种api接口,并且有模拟返回数值;
- 在开发周期使用模拟环境的URL,上线时替换正式环境的URL;
postman
目前第三方API管理平台很有很多,比如postman,easy-mock,apizza,apipost,doclever,swagger等。
这些平台功能其实都差不多,比如支持团队作协、在线API接口调试、API接口文档生成、支持常见模拟请求等。
个人觉得postman还是功能最强大的,也便于开发人员使用,关键是比较稳定。
我们以postman为例来讲解一下如何使用这些第三方API管理平台提供的功能。
首先下载postman客户端版本:https://www.getpostman.com/downloads/;
登录帐号后,按照图示创建一个mock server,这个mock server是postman在自己的服务器上为我们创建的,也省去了我们自己搭建mock server的不便。
点击这里可以复制mock server的地址:
我们在Collections中选择MockTest,然后新建一个getUserInfo的request,再将上面复制得到的mock server地址放到这个接口前面,这样就有了一个完整api接口了:
当然,这个mock server地址可以用一个全局变量来替代:
这样我们在编辑api接口的时候就可以用{{url}}来代替这个mock server地址。
接下来就到了开始配置api接口的步骤了。
在此之前我们先理清一下collection、request、example之间的关系。
collection是管理我们所有request的集合,
request就是我们api接口的名称,比如getUserInfo,
而example是属于request的,用于创建mock的实例,
需要注意的是,一个request可以创建多个example,但是mock server只对最后创建的example有效。
先点击这个getUserInfo这个request右上角的examples,开始创建example实例,每一个example实例都是我们mock的对象:
填写好了request访问方式和response返回结果,我们再回到request里面访问一下:
再到浏览器中验证一下:
可以看到,我们创建的mock接口实例成功。