赶快扔掉 Postman 吧,IntelliJ IDEA 自带的神器,更香
前言
接口调试是每个软件开发从业者必不可少的一项技能,一个项目的的完成,可能接口测试调试的时间比真正开发写代码的时间还要多,几乎是每
所谓工欲善其事必先利其器,在没有尝到 IDEA REST 真香之前, postman 确实是一个非常不错的选择,具有完备的 REST Client 功能和请求历史记录功能。但是当使用了 IDEA REST 之后,postman 就可以丢了,因为,IDEA REST Client 具有 postman 的所有功能,而且还有pE p V Aostman 没有的功能,继续往下看。
从 postman 到 IDEA RESTX ] ] V _ U d | Client
真香1 q ( ! 4 p .定律的原因有如下几个:
- 首先 postman 的所有功能 IDEA REST Client 都具备了,如 REST Client_ W ] / 控制台和历史请求记录
- 其次如果能够在一个生产工具里完成开发和调试的事情,p ^ G U : v干嘛要切换到另一个工具呢
- 然后 IDEA REST Client 还支持环境配置区分的功能,以及f x } ? U y I接口响应断言和脚本化处理的能力
- IDEA REST Client 的请求配置可以用文件配置描述,所以可以跟随项目和项目成员共享
IDEA REST Cli M M ! ? ? p O Pent 控制台
从顶层工具栏依次 Tools -> HTTP Client -& W Ugt; Test RESTFUL Web S` ~ X eervice 打开后,IDEA REST Client 控制台的界面如下样式:
可以看到,这个控制台展^ c f示的功能区和 postman 已经没什么差别了,包括请求方式,请求参数和请求头的8 ) 0 S _填充都已经包含了,特别说明下的是,如果请求的方式是 Authorization :Basic 这种方式认证的话,可以点击下图所示的按钮,会弹出填充用户名和密码的窗口出来,填完后会自动补充到 A[ w c C ~ % w Authorization 的 header 里面去
历D 1 ^ } ( i史请求记录
IntelliJ IDEA 自动将最近执行的 50 个请求w 7 , A / s {以快u D G Y A 5 K W速导航到特定响应并再次发出请求。
文件内容大如下图所示,p 9 4 h h } D C R再次发出请求只要点击那5 : 6 k %个运行按钮即可。如果从请求历史记录再次发出请求,则其执行信息和响应输出的链接将添加到请求历史记录文件的顶部。
构建 HTTP 请求脚本
上面的历史记录就是一个完整的IDEA REST Client请求脚本,如果你是从控制台6 G K触发的,那么可以直接复制历史请求记录的文件放到项目里作为HTTP请求的脚本,给其他成员共享,如果不是,也可以直接新建一个.http或者.rest结尾的文件,IDEA会自动识别为HTTP请求脚本。
语法部分
### 演示 POS 3 z j CT 请求
POST {{baseUrl}}}get?show_env=1
Accv 4 0 M lept: appli[ ? A n 9 w z 1cation/json
{
\"name\":\"a\"
}
##k + s E g J# 演示GET请求
GET {{bZ A s 1 (aseUrl}}}/post
Content-Type: application/x-www-form-urlencoded
id=999&value=content首先通过 ### 三个井号键来分开每个 Q D o H可能发现了上面示例的代码,没有真实的请求地址,取而代之的,是一个 {~ 9 4 K R d d果5 } ! G和接口环境相关的都可以通过配置文件来区分。
首先在 .http 的脚本同目录下创建一个名为 htt~ 1 | # Q Q Dp-cliento D A Y m M H p.private.env.json 的文件,然后内容如下,一级的 key 值时用来区分环境的,比如,dev、uat、pro 等,环境下的对8 2 , S 7 o + V求中能够获取到的环境变量了,你可以直接在请求的 HTTP 的脚本中通过 {{xx}} 占位符的方式获取到这里配置的参! c t n # d g t数
{
\"uat\": {
\"baseUrl\": \"http://gi D 9 g | yateway.xxx.cn/\",
\"username\": \"\",
\"password\": \"\"
},
\"dev\": {
\"baseUrl\": \"http://localhsot:8888/\",
\"username\": \"\",
\"password\": \"\"
}
}那么在选择4 X : ~ x % h C执行请求的时候,IDE_ 6 ( 6A 就会让你选执行那个环境的配置,如:
结果断言
IDEA REST Client 可以针对接口的响应值进行脚本化的断V ] v b言处理,立马从一个接口调试工具上升到测试工具了,
比如:
### SucceS # c 8ssful test: check response status is 200
GET https://httpbin.orp N * ; { B C Qg/status/200
> {%
client.test(\"Request executed successfully\", functioY ^ : _ 9 Dn() {
client.a* } n 9 Nssert(response.status === 200, \"Res/ * J J 7 * z _ Nponse status is nom f I Wt 200\");
});
%}结果值暂存
试想下这样的场景,当一个系统需n ( W # U S要通过认证才能访问的时候,如果用 postman 的时候,是不是先访问登录接口,然后获得 token 后,手动粘贴复制到新的调试接口的 header 参数里面去,这太麻烦了,IDEA REST Client 还有一个真香的功能,可以完美解决这个问题,请看下面的脚本:
### 演示POq 9 w ~ o c ) 3 *ST请求
POST httpsi M p t 1 m://httpbin( % f ( $ U.org/post
Content-Type: application/jd ; ( =son
{
\"user\": \"admin\",
\"password\": \"123456\"
}
>9 f ^ K 6 q q $ J; {% client.global.set(\"auth_token\", response.body.json.token); %}
### 演示GET请求
GET https://M % 3 e u & x fhttpbin.org/headers
Autho4 7 } p 7rization: Bearer {{auth_token}}在第一个认证的请求结束后,可以在 response 里拿到返回的 token 信息,然后我们通过脚本设置到了全局变量里,那么在接下来的接口请求中,就可以直接使用双大括号占位符的方式获取到这个 token 了
结语A Y m T { z A
postmaW H Vn 有口皆碑,确实是一个非常不错的必备工具2 R X I j ,之前给比人推荐这种工具时总是安利他 postman。但是,IDEA REST Client 也真的很不错,值得尝试一下,后面安利这种工具就切换到 IDEA REST Client 了,postman 反正被我丢掉了。和第三方做接口对w R ( [接时,项目里必备一个 rest-ht? 2 e ! S L atp.http 接口请求文件,满足自己的同时也成方便了他人。
本文来源:my.oschina.net/kek( , W { ting/blog/3104972