接口调试是每个软件开发从业者必不可少的一项技能,一个项目的的完成,可能接口测试调试的时间比真正开发写代码的时间还要多,几乎是每个开发的日常工作项。所谓工欲善其事必先利其器,在没有尝到idea rest真香之前,postman(chrome的一款插件)确实是一个非常不错的选择,具有完备的rest client功能和请求历史记录功能。但是当使用了idea rest之后,postman就可以丢了,因为,idea rest client具有postman的所有功能,而且还有postman没有的功能,继续往下看。
从postman到idea rest client
真香定律的原因有如下几个:
首先postman的所有功能idea rest client都具备了,如rest client控制台和历史请求记录
其次如果能够在一个生产工具里完成开发和调试的事情,干嘛要切换到另一个工具呢
然后idea rest client还支持环境配置区分的功能,以及接口响应断言和脚本化处理的能力
idea rest client的请求配置可以用文件配置描述,所以可以跟随项目和项目成员共享
idea rest client控制台
从顶层工具栏依次tools -> http client -> test restful web service 打开后,idea rest client控制台的界面如下样式:
可以看到,这个控制台展示的功能区和postman已经没什么差别了,包括请求方式,请求参数和请求头的填充都已经包含了,特别说明下的是,如果请求的方式是authorization :basic这种方式认证的话,可以点击下图所示的按钮,会弹出填充用户名和密码的窗口出来,填完后会自动补充到authorization 的header里面去。
历史请求记录
intellij idea自动将最近执行的50个请求保存到http-requests-log.http 文件中,该文件存储在项目的.idea / httprequests / 目录下。使用请求历史记录,您可以快速导航到特定响应并再次发出请求。文件内容大如下图所示,再次发出请求只要点击那个运行按钮即可。如果从请求历史记录再次发出请求,则其执行信息和响应输出的链接将添加到请求历史记录文件的顶部。
构建http请求脚本
上面的历史记录就是一个完整的idea rest client请求脚本,如果你是从控制台触发的,那么可以直接复制历史请求记录的文件放到项目里作为http请求的脚本,给其他成员共享,如果不是,也可以直接新建一个.http或者.rest结尾的文件,idea会自动识别为http请求脚本。
语法部分
### 演示post请求post {{baseurl}}}get?show_env=1accept: application/json{ name:a}### 演示get请求get {{baseurl}}}/postcontent-type: application/x-www-form-urlencodedid=999&value=content
首先通过###三个井号键来分开每个请求体,然后请求url和header参数是紧紧挨着的,请求参数不管是post的body传参还是get的parameter传参,都是要换行的
环境区分
细心的你可能发现了上面示例的代码,没有真实的请求地址,取而代之的,是一个{{baseurl}}的占位符,这个就是idea rest client真香的地方,支持从指定的配置文件中获取到环境相关的配置参数,不仅baseurl可以通过占位符替换,一些请求的参数如果和接口环境相关的都可以通过配置文件来区分。
首先在.http的脚本同目录下创建一个名为http-client.private.env.json的文件,然后内容如下,一级的key值时用来区分环境的,比如,dev、uat、pro等,环境下的对象就是一次http请求中能够获取到的环境变量了,你可以直接在请求的http的脚本中通过{{xx}}占位符的方式获取到这里配置的参数。
{ uat: { baseurl: http://gateway.xxx.cn/, username: , password: }, dev: { baseurl: http://localhsot:8888/, username: , password: }}
那么在选择执行请求的时候,idea就会让你选执行那个环境的配置,如:
结果断言
idea rest client可以针对接口的响应值进行脚本化的断言处理,立马从一个接口调试工具上升到测试工具了,比如:
### successful test: check response status is 200get https://httpbin.org/status/200> {%client.test(request executed successfully, function() { client.assert(response.status === 200, response status is not 200);});%}
结果值暂存
试想下这样的场景,当一个系统需要通过认证才能访问的时候,如果用postman的时候,是不是先访问登录接口,然后获得token后,手动粘贴复制到新的调试接口的header参数里面去,这太麻烦了,idea rest client还有一个真香的功能,可以完美解决这个问题,请看下面的脚本:
### 演示post请求post https://httpbin.org/postcontent-type: application/json{ user: admin, password: 123456}> {% client.global.set(auth_token, response.body.json.token); %}### 演示get请求get https://httpbin.org/headersauthorization: bearer {{auth_token}}
在第一个认证的请求结束后,可以在response里拿到返回的token信息,然后我们通过脚本设置到了全局变量里,那么在接下来的接口请求中,就可以直接使用双大括号占位符的方式获取到这个token了。
结语
postman有口皆碑,确实是一个非常不错的必备工具,之前给比人推荐这种工具时总是安利他postman。但是,idea rest client也真的很不错,值得尝试一下,后面安利这种工具就切换到idea rest client了,postman反正被我丢掉了。和第三方做接口对接时,项目里必备一个rest-http.http接口请求文件,满足自己的同时也成方便了他人。
达6000条测试用例!忆联消费级存储实验室向业界标杆看齐
高压断路器的型号代表什么意思
如何更加深入理解I2C总线、协议及应用
详细的ChatGPT Plus会员充值教程
iPhone8再曝光:新增多项重磅功能,价格上涨
IDEA REST Client使用教程
笙泉M0系列MCU应用于电池管理系统(BMS)
比特币日证明了阿根廷对加密货币依然热爱
MTK 6765 八核安卓核心板主板定制方案!
如何用光做产品的个性化表达
烧钱难长久,新造车企业遭遇“交付死”
如何解决变频器对PLC模拟量干扰?
5G将为VR/AR的发展带来新的机遇
基于一种手机白光LED背光驱动电路的设计
宜百利带您走近小米蓝牙遥控器
英特尔欲转型AI迎战英伟达,建立英特尔帝国
ZG PDU电源分配解决方案 实现12V/24V电源输出分配管理
什么是VQF格式
电抗器的如何取电感值?独立滤波变换器电路设计
诺基亚VR相机设备OZO:由8个同步快门传感器和8个麦克风组成