问题背景
这段时间使用开发一些Rest API相关的功能,准备做一些接口的简单测试,快速的验证一下API功能是否正常,正好觉得IntelliJ IDEA中的HTTP Client功能非常方便,它允许我们直接在编辑器中操作,正好记录一下。
解决方案
1、创建HTTP请求文件
在idea工具的Tools
菜单中,选择HTTP Client
,在里面选择创建一个测试请求,或者你创建一个.http
或.rest
文件,通常在项目的src
目录中,例如src/test/http/
。你可以右键点击该目录,选择New
-> File
,然后输入文件名如api_requests.http
。
2、编写HTTP请求
在创建的文件中,可以编写HTTP请求。以下是几个基本请求的例子:
GET请求
向http://localhost:8080/api/users
发送一个GET请求,并期望JSON格式的响应。
GET http://localhost:8080/api/users
Accept: application/json
POST请求
向http://localhost:8080/api/users
发送一个POST请求,并期望JSON格式的响应。
POST http://localhost:8080/api/users
Content-Type: application/json
Accept: application/json
{
"name": "John Doe",
"email": "johndoe@example.com"
}
PUT请求
向http://localhost:8080/api/users/1
发送一个PUT请求,用来更新ID为1的用户信息。
PUT http://localhost:8080/api/users/1
Content-Type: application/json
Accept: application/json
{
"name": "Jane Doe",
"email": "janedoe@example.com"
}
DELETE请求
向http://localhost:8080/api/users/1
发送一个PUT请求,用来更新ID为1的用户信息。
DELETE http://localhost:8080/api/users/1
请求写好了之后,就是验证结果对不对问题,我们可以在控制台查看结果是否正确,只是几个接口,我们可以自己看一看,但是如果是几十个接口做测试,这再一个一个的去看,这就要了老命了,那么是不是还可以通过代码自动校验结果呢?
3、执行和验证请求
编写好请求后,你可以通过点击请求行旁边的运行图标(绿色的三角形)来执行它。执行后,IDEA会在下方的Run窗口中显示HTTP响应。
为了验证返回结果是否正确,你可以在HTTP请求下方写上一些验证条件:
GET http://localhost:8080/api/users
Accept: application/json
> {
%
client.test("Request executed successfully", function() {