API开发不可少,巧用postman
1.postman
作为一枚后端开发,难免需要调试接口。postman是一款功能强大的接口调试利器,基本使用方法我就不介绍了,度娘一搜一大把。下面介绍一些在项目开发中实用的postman技巧。
2. 巧用postman
2.1 环境变量
在项目实际开发过程中,往往部署了不止一个服务器,本地开发服、线上测试服、线上生产服,而我们在调试接口时,常常需要在多个服之间来回切换,postman提供的环境变量可以帮助我们灵活地处理这个问题。
操作:
1)打开postman客户端,点击右上角的设置按钮,选择“MANAGE ENVIROMENTS”,进入管理环境变量页面;
2)在管理环境变量页面中,点击“Add”按钮,添加环境变量;
图2.1.1-添加环境3)填写当前环境的名称,添加环境中的变量名及对应值,创建;
图2.1.2-创建环境变量4)在接口请求中使用环境变量,并选择当前使用的环境,下图中的例子相当于请求 http://localhost/api/auth/login/mobile=xxx&password=xxx
图 2.1.3 使用环境变量通过上述的操作,我们就可以在各个服之间方便的切换。
2.2 collections集合
postman的左侧栏有一个collections,在这里可以将接口分类收集,像我自己,就会一个项目的接口划分为一个项目,项目里面根据功能划分为子集合,子集合里面在放具体的接口,分门别类容易管理。关于集合的创建我就不说了,这个很简单,大家在网上搜一下。
图2.2-collections2.3 接口结果示例 example
强大的postman还有收藏接口的响应结果的功能。
操作:
1)添加example
在页面的右上角有一个“Examples”字样的下拉框,点击可查看已经添加的结果示例,可通过橙色的“Add Example”按钮添加示例,默认会将response区的值添加到示例中。
图2.3.1-添加接口的响应结果示例2)查看example
点击上图中“Examples”按钮,下拉可查看到已添加的示例,点击即可查看示例详情
图2.3.2-example详情2.4 collections的导出和导入
1)导出collections
选中要导出的collections,右键,选中“export”,选择导出即可,将会将集合导出为json格式的文件。
2)导入
点击页面左上角的“import”按钮,添加导出的json文件,即可将collections导入。
3.偷懒,利用postman省略接口文档
通过上述介绍的几点小技巧,如果你跟项目组同事隔得近,方面交流的话,那么,你可以尝试偷个小懒,省掉接口文档(小声哔哔)。
a.首先,将项目中的接口分门别类,建立项目集合,划分功能子集合
b.对于接口请求,在定义请求的参数时,在description对参数进行详细描述;
c.添加接口的结果示例,对于结果有多种情况的,添加多个示例,因为postman的示例不能对响应参数添加description,这里就要求开发者在定义响应参数时要做到望文生义,最好统一规则;
d.通过导入导出同步接口;
现在网上也有很多优秀管理接口文档的工具,有些需要一定的学习成本例如 swagger,因本人日常开发习惯使用postman测试接口,所以出此下策,各位大佬若有好的建议,请多赐教~