IDEA教程 - 一个被低估的功能:IDEA REST Client 使用教程

接口调试/分析不用我多解释了,是每一位程序员必备的技能。
IDEA REST Client 可以满足你所有开发和调试的需求,并且支持环境配置区分以及接口响应断言和脚本化处理,请求配置也可以用文件配置描述。
控制台
打开 IDEA,点击顶部菜单栏的 Tools
--> HTTP Client
--> Test RESTFUL Web Service
,打开 IDEA REST Client
的控制台。
在控制台请求方式、请求参数和请求头都有。如果请求方式是 Authorization :Basic
这种方式认证的话,可以点击下图所示的按钮,会弹出填充用户名和密码的窗口出来,填完后会自动补充到 Authorization
的 header 里面去.
历史请求记录
IDEA 会自动地将近期执行的50个请求保存至 http-requests-log.http
文件中,然后将该文件存储在项目的 .idea / httpRequests /
目录下。
当你使用请求历史记录时,你可以快速导航到特定响应并且再次发出请求。
如图示,只需要点击那个运行按钮就能再次发出请求。如果从请求历史记录再次发出请求,则其执行信息和响应输出的链接将添加到请求历史记录文件的顶部。
环境变量
我们在编写HTTP请求时,可以使用环境变量来参数化其元素 。在项目中定义一组环境变量包含所需的主机定义。执行请求时,就可以在定义的环境之间进行选择。
变量有以下请求组件的值:
- 请求ip,端口和路径
- 查询参数或值
- 请求头的值
- 在外部文件为请求体提供任意值
定义环境变量
环境变量是在环境文件中定义的,文件在与 .http
文件相同目录下,文件可以是 : rest-client.env.json
或者 http-client.env.json
, rest-client.private.env.json
或者 http-client.private.env.json
rest-client.env.json
或者 http-client.env.json
表示这个文件是包含普通的变量,并把里面的变量分发到项目中。
rest-client.private.env.json
或者 http-client.private.env.json
表示该文件是一个私人的文件,可能包括密码,令牌,证书和其他敏感信息。默认情况下,此文件被添加到 VCS 忽略文件列表中。在 http-client.private.env.json
文件中指定的变量的值将覆盖环境文件中的值。
语法部分
### 演示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 传参,都是要换行的
响应处理程序脚本
将脚本插入请求中
以 >
开头,然后把脚本包装在 {%%}
里面。
断言
GET https://example.com/status/200
> {%
client.test("Request executed successfully", function() {
client.assert(response.status === 200, "Response status is not 200");
});
%}
脚本日志
client.log("this is log");
想了解更多idea的“骚操作”,请查看:IDEA教程