共计 2804 个字符,预计需要花费 8 分钟才能阅读完成。
前言
接口调试是每个软件开发从业者必不可少的一项技能,一个我的项目的的实现,可能接口测试调试的工夫比真正开发写代码的工夫还要多,简直是每个开发的日常工作项。所谓工欲善其事必先利其器,在没有尝到 IDEA REST 真香之前,postman(chrome 的一款插件)的确是一个十分不错的抉择,具备齐备的 REST Client 性能和申请历史记录性能。然而当应用了 IDEA REST 之后,postman 就能够丢了,因为,IDEA REST Client 具备 postman 的所有性能,而且还有 postman 没有的性能,持续往下看。
从 postman 到 IDEA REST Client
真香定律的起因有如下几个:
1. 首先 postman 的所有性能 IDEA REST Client 都具备了,如 REST Client 控制台和历史申请记录
2. 其次如果可能在一个生产工具里实现开发和调试的事件,干嘛要切换到另一个工具呢
3. 而后 IDEA REST Client 还反对环境配置辨别的性能,以及接口响应断言和脚本化解决的能力
4.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=1
Accept: application/json
{"name":"a"}
### 演示 GET 申请
GET {{baseUrl}}}/post
Content-Type: application/x-www-form-urlencoded
id=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 200
GET 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/post
Content-Type: application/json
{
"user": "admin",
"password": "123456"
}
> {% client.global.set("auth_token", response.body.json.token); %}
### 演示 GET 申请
GET https://httpbin.org/headers
Authorization: Bearer {{auth_token}}
在第一个认证的申请完结后,能够在 response 里拿到返回的 token 信息,而后咱们通过脚本设置到了全局变量里,那么在接下来的接口申请中,就能够间接应用双大括号占位符的形式获取到这个 token 了
结语
postman 交口称誉,的确是一个十分不错的必备工具,之前给比人举荐这种工具时总是安利他 postman。然而,IDEA REST Client 也真的很不错,值得尝试一下,前面安利这种工具就切换到 IDEA REST Client 了,postman 反正被我丢掉了。和第三方做接口对接时,我的项目里必备一个 rest-http.http 接口申请文件,满足本人的同时也成不便了别人。
起源:my.oschina.net/keking/blog/3104972