Rest Client在idea的使用

本文最后更新于:November 28, 2021 am

1.安装

首先,打开IntelliJ IDEA或pycharm,安装Rest Client。

File -> Setting -> Plug-ins -> Browse Repository

搜索Rest Client,点击右侧的install,稍等片刻会提醒要重启IDEA,重启后安装结束。

2.使用

使用时候,从顶层工具栏依次Tools -> HTTP Client -> Test RESTFUL Web Service 打开

之后,IDEA REST Client控制台的界面如下样子。

这个控制台展示的功能区有请求方式,请求参数和请求头的填充等等。

如果需要用户名、密码验证,点击右侧按钮,会弹出填充用户名和密码的窗口。

填完后会自动补充到Authorization 的header里面去。

Rest Client插件会自动将最近执行的50个请求保存到http-requests-log.http 文件中。

该文件存储在项目的.idea /httpRequests/目录下。

使用请求历史记录,用户可以快速导航到特定响应并再次发出请求。

除了构建请求,发起RESTful请求,Rest Client插件还可以完成如下postman不能做到的功能:

• 模板构建请求;

• 多个环境区分;

• 结果断言;

• 结果暂存;

添加 token

3.pycharm中测试结果断言及生成测试报告

先进入rest client插件界面,从顶层工具栏依次Tools -> HTTP Client -> Test RESTFUL Web Service 打开后, REST Client控制台的界面如下样式:

点一下右上方的“Convert request to the new format”,接口请求各个参数自动生成一个配置文件,在IDE上边文件编辑框内。

文件名为:rest-api.http,默认存放在.PyCharm2019.2configscratches。

测试结果断言设置

把上面生成的rest-api.http文件内容都删除,重新写入如下内容:

解释:

  1. client.test,表示下面的是一个测试用例,第一个参数是测试用例名字,第二个参数是一个函数包含着测试断言。

  2. 断言由client.assert带出,第一个参数是判断条件,第二个参数是测试失败时候战士的信息。

鼠标移动到“GET”右侧的按钮,会出现“Run httpbin.org”(Run 后面的是测试接口的链接)

点击弹出的标签,测试执行。Console界面自动展示出执行结果。

点击“Console”标签右侧的“test”标签,可以看到具体执行结果:

自己写一个测试用例和断言

仿照上面的例子,写一个测试用例和断言,判断response的headers里面的某一个字段。

还是像上面那样执行测试用例。

“console”标签没变化,但是右侧的“test”标签内容很不一样了。

两个测试用例都通过。

生成检测报告

在“test”标签里,点击“Export Test Result”,可以将测试结果导出成测试报告

在弹出对话框中,保存测试报告到指定位置。

测试报告:

测试调试

如果想调试测试用例、测试断言,或者想看中间结果,怎么办?

可以用:client.log函数

看一下修改后的例子:

比如:想要看一下GET接口返回的headers信息,可以直接client.log(response.headers)打印结果。上下的两个client.log(“============”)没有实际意义,只是让结果看起来更容易找到。

像上面提到的那样执行之后,结果在“test”标签页里可以看到:

执行多次后出现的 json 文件

点击右侧的蓝色反向双箭头,可以看到这些json链接的作用是为了让用户可以对比任意两次接口测试结果: