学会IDEARESTClient后，postman就可以丢掉了...

小Hub领读&＃xff1a;

postman好用是有道理的&＃xff0c;而且现在也习惯用postman了呀&＃xff0c;工具越来越多&＃xff0c;用习惯的就好。

作者&＃xff1a;凯京技术团队

https://my.oschina.net/keking/blog/3104972

前言

接口调试是每个软件开发从业者必不可少的一项技能&＃xff0c;一个项目的的完成&＃xff0c;可能接口测试调试的时间比真正开发写代码的时间还要多&＃xff0c;几乎是每个开发的日常工作项。所谓工欲善其事必先利其器&＃xff0c;在没有尝到 IDEA REST 真香之前&＃xff0c;postman&＃xff08;chrome 的一款插件&＃xff09;确实是一个非常不错的选择&＃xff0c;具有完备的 REST Client 功能和请求历史记录功能。但是当使用了 IDEA REST 之后&＃xff0c;postman 就可以丢了&＃xff0c;因为&＃xff0c;IDEA REST Client 具有 postman 的所有功能&＃xff0c;而且还有 postman 没有的功能&＃xff0c;继续往下看。

从 postman 到 IDEA REST Client

真香定律的原因有如下几个&＃xff1a;

1. 首先 postman 的所有功能 IDEA REST Client 都具备了&＃xff0c;如 REST Client 控制台和历史请求记录

2. 其次如果能够在一个生产工具里完成开发和调试的事情&＃xff0c;干嘛要切换到另一个工具呢

3. 然后 IDEA REST Client 还支持环境配置区分的功能&＃xff0c;以及接口响应断言和脚本化处理的能力

4. IDEA REST Client 的请求配置可以用文件配置描述&＃xff0c;所以可以跟随项目和项目成员共享

IDEA REST Client 控制台

从顶层工具栏依次 Tools -> HTTP Client -> Test RESTFUL Web Service 打开后&＃xff0c;IDEA REST Client 控制台的界面如下样式&＃xff1a;

可以看到&＃xff0c;这个控制台展示的功能区和 postman 已经没什么差别了&＃xff0c;包括请求方式&＃xff0c;请求参数和请求头的填充都已经包含了&＃xff0c;特别说明下的是&＃xff0c;如果请求的方式是 Authorization :Basic 这种方式认证的话&＃xff0c;可以点击下图所示的按钮&＃xff0c;会弹出填充用户名和密码的窗口出来&＃xff0c;填完后会自动补充到 Authorization 的 header 里面去

历史请求记录

IntelliJ IDEA 自动将最近执行的 50 个请求保存到 http-requests-log.http 文件中&＃xff0c;该文件存储在项目的.idea / httpRequests / 目录下。使用请求历史记录&＃xff0c;您可以快速导航到特定响应并再次发出请求。文件内容大如下图所示&＃xff0c;再次发出请求只要点击那个运行按钮即可。如果从请求历史记录再次发出请求&＃xff0c;则其执行信息和响应输出的链接将添加到请求历史记录文件的顶部。

构建 HTTP 请求脚本

上面的历史记录就是一个完整的 IDEA REST Client 请求脚本&＃xff0c;如果你是从控制台触发的&＃xff0c;那么可以直接复制历史请求记录的文件放到项目里作为 HTTP 请求的脚本&＃xff0c;给其他成员共享&＃xff0c;如果不是&＃xff0c;也可以直接新建一个. http 或者. rest 结尾的文件&＃xff0c;IDEA 会自动识别为 HTTP 请求脚本。

语法部分

### 演示POST请求
POST {{baseUrl}}}get?show_env&＃61;1
Accept: application/json{"name":"a"
}
### 演示GET请求GET {{baseUrl}}}/post
Content-Type: application/x-www-form-urlencodedid&＃61;999&value&＃61;content


首先通过 ### 三个井号键来分开每个请求体&＃xff0c;然后请求 url 和 header 参数是紧紧挨着的&＃xff0c;请求参数不管是 POST 的 body 传参还是 GET 的 parameter 传参&＃xff0c;都是要换行的

环境区分

细心的你可能发现了上面示例的代码&＃xff0c;没有真实的请求地址&＃xff0c;取而代之的&＃xff0c;是一个 {{baseUrl}} 的占位符&＃xff0c;这个就是 IDEA REST Client 真香的地方&＃xff0c;支持从指定的配置文件中获取到环境相关的配置参数&＃xff0c;不仅 baseUrl 可以通过占位符替换&＃xff0c;一些请求的参数如果和接口环境相关的都可以通过配置文件来区分。

搜索公纵号&＃xff1a;MarkerHub&＃xff0c;关注回复[ vue ]获取前后端入门教程&＃xff01;

首先在. http 的脚本同目录下创建一个名为 http-client.private.env.json 的文件&＃xff0c;然后内容如下&＃xff0c;一级的 key 值时用来区分环境的&＃xff0c;比如&＃xff0c;dev、uat、pro 等&＃xff0c;环境下的对象就是一次 HTTP 请求中能够获取到的环境变量了&＃xff0c;你可以直接在请求的 HTTP 的脚本中通过 {{xx}} 占位符的方式获取到这里配置的参数

{"uat": {"baseUrl": "http://gateway.xxx.cn/","username": "","password": ""},"dev": {"baseUrl": "http://localhsot:8888/","username": "","password": ""}
}


那么在选择执行请求的时候&＃xff0c;IDEA 就会让你选执行那个环境的配置&＃xff0c;如&＃xff1a;

结果断言

IDEA REST Client 可以针对接口的响应值进行脚本化的断言处理&＃xff0c;立马从一个接口调试工具上升到测试工具了&＃xff0c;比如&＃xff1a;

### Successful test: check response status is 200
GET https://httpbin.org/status/200> {%
client.test("Request executed successfully", function() {client.assert(response.status &＃61;&＃61;&＃61; 200, "Response status is not 200");
});
%}


结果值暂存

试想下这样的场景&＃xff0c;当一个系统需要通过认证才能访问的时候&＃xff0c;如果用 postman 的时候&＃xff0c;是不是先访问登录接口&＃xff0c;然后获得 token 后&＃xff0c;手动粘贴复制到新的调试接口的 header 参数里面去&＃xff0c;这太麻烦了&＃xff0c;IDEA REST Client 还有一个真香的功能&＃xff0c;可以完美解决这个问题&＃xff0c;请看下面的脚本&＃xff1a;

### 演示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}}


在第一个认证的请求结束后&＃xff0c;可以在 response 里拿到返回的 token 信息&＃xff0c;然后我们通过脚本设置到了全局变量里&＃xff0c;那么在接下来的接口请求中&＃xff0c;就可以直接使用双大括号占位符的方式获取到这个 token 了

结语

postman 有口皆碑&＃xff0c;确实是一个非常不错的必备工具&＃xff0c;之前给比人推荐这种工具时总是安利他 postman。但是&＃xff0c;IDEA REST Client 也真的很不错&＃xff0c;值得尝试一下&＃xff0c;后面安利这种工具就切换到 IDEA REST Client 了&＃xff0c;postman 反正被我丢掉了。和第三方做接口对接时&＃xff0c;项目里必备一个 rest-http.http 接口请求文件&＃xff0c;满足自己的同时也成方便了他人。

&＃xff08;完&＃xff09;

MarkerHub文章索引&＃xff1a;&＃xff08;点击阅读原文直达&＃xff09;

https://github.com/MarkerHub/JavaIndex
【推荐阅读】
史上最污技术解读&＃xff0c;我竟然秒懂了
Spring Boot 注解大全&＃xff0c;一键收藏了&＃xff01;
两年滴滴和头条的后端开发经验&＃xff01;字字都是肺腑之言&＃xff01;
两难&＃xff01;到底用Apache BeanUtils还是Spring BeanUtils&＃xff1f;
数据量很大&＃xff0c;分页查询很慢&＃xff0c;有什么优化方案&＃xff1f;Lambda表达式入门&＃xff0c;看这篇就够了&＃xff01;
参考&＃xff1a;创业公司搭建自己的技术架构


好文章&＃xff01;点个在看&＃xff01;