IDEA中的轻量级接口请求工具 | HTTP Client 新手指南

pivoteic

发布于 2023-7-10 16:12

7831浏览

0收藏

一、简介

HTTP Client 是 IDEA 自带的一款简洁轻量级的接口调用插件，通过它，我们能在 IDEA 上开发，调试，测试 RESTful Web 服务。

二、快速上手

1、首先要确保 HTTP Client 插件是安装启动的，默认是已安装启动的。若没有安装，在 File - Settings - Plugins 路径下进行安装：

IDEA中的轻量级接口请求工具 | HTTP Client 新手指南-鸿蒙开发者社区

2、可以在项目根目录下创建一个存储请求文件的文件夹，然后在里面创建HTTP Client 请求文件：

IDEA中的轻量级接口请求工具 | HTTP Client 新手指南-鸿蒙开发者社区

3、打开创建的文件，可以直接的点击右上角工具栏中的add request，选择相应的请求类型即可添加，如下图所示get请求：

IDEA中的轻量级接口请求工具 | HTTP Client 新手指南-鸿蒙开发者社区

4、点击左边的运行按钮即可发送请求，结果如下：

IDEA中的轻量级接口请求工具 | HTTP Client 新手指南-鸿蒙开发者社区

三、GET相关请求示例

### GET request with a header
GET https://httpbin.org/ip
Accept: application/json

### GET request with parameter
GET https://httpbin.org/get?show_env=1
Accept: application/json

### GET request with environment variables
GET {{host}}/get?show_env={{show_env}}
Accept: application/json

### GET request with disabled redirects
# @no-redirect
GET http://httpbin.org/status/301

### GET request with dynamic variables
GET http://httpbin.org/anything?id={{$uuid}}&ts={{$timestamp}}

###1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.

四、POST相关请求示例

### Send POST request with json body
POST https://httpbin.org/post
Content-Type:application/json

{
  "id": 999,
  "value": "content"
}

### Send POST request with body asparameters
POST https://httpbin.org/post
Content-Type:application/x-www-form-urlencoded

id=999&value=content

### Send a form with the text and file fields
POST https://httpbin.org/post
Content-Type:multipart/form-data;boundary=WebAppBoundary

--WebAppBoundary
Content-Disposition: form-data; name="element-name"
Content-Type: text/plain

Name
--WebAppBoundary
Content-Disposition: form-data; name="data";filename="data.json"
Content-Type:application/json

< ./request-form-data.json
--WebAppBoundary--

### Send request with dynamic variables in request's body
POST https://httpbin.org/post
Content-Type:application/json

{
  "id":{{$uuid}},
  "price":{{$randomInt}},
  "ts":{{$timestamp}},
  "value": "content"
}

###1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
33.
34.
35.
36.
37.
38.
39.
40.
41.
42.
43.

五、PUT相关请求示例

PUT http://localhost:8080/person/put
Content-Type:application/json

{"name": "name111","age": 17}1.
2.
3.
4.

六、PATCH相关请求示例

###
PATCH http://localhost:8080/person/put
Content-Type:application/json

{"name": "demo111","age": 17}1.
2.
3.
4.
5.

七、带鉴权验证的示例

###
PATCH http://localhost:8080/person/put
Content-Type: application/json

{"name": "demo111","age": 17}
七、带鉴权验证的示例
### Basic authorization.
GET https://httpbin.org/basic-auth/user/passwd
Authorization: Basic user passwd

### Basic authorization with variables.
GET https://httpbin.org/basic-auth/user/passwd
Authorization: Basic {{username}} {{password}}

### Digest authorization.
GET https://httpbin.org/digest-auth/realm/user/passwd
Authorization: Digest user passwd

### Digest authorization with variables.
GET https://httpbin.org/digest-auth/realm/user/passwd
Authorization: Digest {{username}} {{password}}

### Authorization by token, part 1. Retrieve and save token.
POST https://httpbin.org/post
Content-Type: application/json

{
  "token": "my-secret-token"
}

> {% client.global.set("auth_token", response.body.json.token); %}

### Authorization by token, part 2. Use token to authorize.
GET https://httpbin.org/headers
Authorization: Bearer {{auth_token}}

###1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
33.
34.
35.
36.
37.

八、断言方式请求示例

### 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");
});
%}

### Failed test: check response status is 200
GET https://httpbin.org/status/404

> {%
client.test("Request executed successfully", function() {
  client.assert(response.status === 200, "Response status is not 200");
});
%}

### Check response status and content-type
GET https://httpbin.org/get

> {%
client.test("Request executed successfully", function() {
  client.assert(response.status === 200, "Response status is not 200");
});

client.test("Response content-type is json", function() {
  var type = response.contentType.mimeType;
  client.assert(type === "application/json", "Expected 'application/json' but received '" + type + "'");
});
%}

### Check response body
GET https://httpbin.org/get

> {%
client.test("Headers option exists", function() {
  client.assert(response.body.hasOwnProperty("headers"), "Cannot find 'headers' option in response");
});
%}

###1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
33.
34.
35.
36.
37.
38.
39.
40.
41.
42.