HTTP 客户端

Create HTTP request files
创建 HTTP 请求文件

Compose HTTP requests 编写 HTTP 请求

###
Method Request-URI HTTP-Version
Header-field: Header-value

Request-Body

After the ### separator, you can enter any comments preceded by # or //.
在###分隔符之后，您可以输入以#或//开头的任何注释。

Alternatively, use live templates. In the editor, you can press ⌘Сmd0J to view the list of available templates. For example, gtr expands to a simple GET request; mptr expands to a multipart/form-data POST request.
或者，使用实时模板。在编辑器中，您可以按下 ⌘Сmd 0J 来查看可用模板列表。例如，gtr扩展为一个简单的 GET 请求；mptr扩展为一个multipart/form-data POST 请求。

tip 提示
If you use application/x-www-form-urlencoded content type, you should use % to escape %, &, =, and + special characters in the keys and values of the request body.
如果您使用 application/x-www-form-urlencoded 内容类型,您应该使用%对请求体的键和值中的特殊字符%, &, =, 以及 + 进行转义。
For example, for a server to receive field1=value%2Bvalue&field2=value%26value (where %2B corresponds to + and %26 corresponds to &), the request body should be as follows:
例如，对于服务器来接收 field1=value%2Bvalue&field2=value%26value （其中%2B对应于+，%26对应于&），请求体应如下：
POST https://ijhttp-examples.jetbrains.com/post
Content-Type: application/x-www-form-urlencoded

field1=value%+value&field2=value%&value
Or you can write encoded values right away, for example value1%ADvalue2 for value1 value2 or value1%2Bvalue2 for value1+value2.
或者您可以直接编写编码值，例如 value1%ADvalue2 是指 value1 value2 或者 value1%2Bvalue2 是指 value1+value2。

HTTP/2

GET https://example.org HTTP/2

Convert cURL requests 转换 cURL 请求

curl 'https://httpbin.org/' -H 'Connection: keep-alive' -H 'Accept: text/html' -H 'Accept-Encoding:
gzip, deflate' -H 'Accept-Language: en-US,en;q=0.9,es;q=0.8'

# curl 'http://httpbin.org/' -H 'Connection: keep-alive' -H 'Accept: text/html' -H 'Accept-Encoding: gzip, deflate' -H 'Accept-Language: en-US,en;q=0.9,es;q=0.8'
GET http://httpbin.org/
Connection: keep-alive
Accept: text/html
Accept-Encoding: gzip, deflate
Accept-Language: en-US,en;q=0.9,es;q=0.8

###

Option 选项	Description 描述
-X, --request -X，--请求	The request method to use. 使用的请求方法。
-H, --header -H, --头	The request header to include in the request. 在请求中包含的请求头。
-u, --user -u，--用户 --basic -基本 --digest -摘要	The user's credentials to be provided with the request, and the authorization method to use. 用户需要通过请求提供凭据，并选择授权方法。
-d, --data, --data-ascii -d，--数据，--数据-ascii --data-binary --数据二进制 --data-raw --数据原始 --data-urlencode	The data to be sent in a POST request. 要发送的数据在 POST 请求中。
-F, --form -F，--表单	The multipart/form-data message to be sent in a POST request. 要在 POST 请求中发送的 multipart/form-data 消息。
--url --网址	The URL to fetch (mostly used when specifying URLs in a config file). 用于提取的 URL（在配置文件中指定 URL 时使用）。
-i, --include -包括 --包括	Defines whether the HTTP response headers are included in the output. 定义是否包含在输出中包含 HTTP 响应头。
-v, --verbose -v，--详细	Enables the verbose operating mode. 启用详细操作模式。
-L, --location -L，--位置	Enables resending the request in case the requested page has moved to a different location. 如果请求的页面已经移动到不同的位置，允许重新发送请求。

Import Postman collections and environments
导入 Postman 集合和环境

Use response handler and pre-request scripts
使用响应处理程序和预请求脚本

Insert response handler scripts
插入响应处理程序脚本

To insert the script in-place, prepend it with > and enclose it in {% %}:
要在原地插入脚本，请在其前面加上>并将其括在{% %}中：
```
GET host/api/test

> {%
// Response Handler Script
...
%}
```
To insert the script from an external file, prepend it with >:
要插入外部文件中的脚本，请在其前面添加>：
```
GET host/api/test

> scripts/my-script.js
```

Insert pre-request scripts
插入预请求脚本

To insert the script in-place, prepend it with < and enclose it in {% %}:
要在原地插入脚本，请在前面添加<，并用{% %}括起来：
```
< {%
    request.variables.set("petName", "Bella")
%}
POST https://example.org/pets/{{petName}}
```
To insert the script from an external file, prepend it with <:
要从外部文件插入脚本，请在前面加上<：
```
< scripts/my-script.js

POST https://example.org/pets/{{petName}}
```

Import JavaScript code 导入 JavaScript 代码

Export the needed values from a JavaScript file. The HTTP Client supports export statements in the following formats:
从 JavaScript 文件中导出所需的值。HTTP Client 支持以下格式的导出语句：

export let name1, name2/*, … */; // also var
export const name1 = 1, name2 = 2/*, … */; // also var, let
export function functionName() { /* … */ }

export { name1, /* …, */ nameN };
export { variable1 as name1, variable2 as name2, /* …, */ nameN };

export default expression;
export default function functionName() { /* … */ }
export default function () { /* … */ }

Import the needed values into your response handler or pre-request script. The HTTP Client supports import statements in the following formats:
将所需的值导入到您的响应处理程序或预请求脚本中。HTTP 客户端支持以下格式的import语句：
```
import defaultExport from "module-name";
import * as name from "module-name";
import { export1 } from "module-name";
import { export1 as alias1 } from "module-name";
import { export1, export2 } from "module-name";
import { export1, export2 as alias2, /* … */ } from "module-name";
import defaultExport, { export1, /* … */ } from "module-name";
import defaultExport, * as name from "module-name";
import "module-name"; // side effect import
```
note 注意
If you want to run some tests from an external file and do not need to import anything from them, you can use side effect import in your response handler script, for example import 'test-scripts/mytests'. This can be useful if you have common tests and want to reuse them in multiple requests while also keeping the ability to write (or import) individual tests for some requests.
如果您想从外部文件运行一些测试，并且不需要从中导入任何内容，您可以在响应处理程序脚本中使用副作用导入，例如 import 'test-scripts/mytests'。这对于拥有常见测试并希望在多个请求中重用它们的情况非常有用，同时还可以保持编写（或导入）某些请求的单独测试的能力。

Response handler scripts and pre-request scripts are written in JavaScript ECMAScript 2023, with coding assistance and documentation handled by the bundled HTTP Pre-Request and Response Handler library. For in-place scripts, this functionality is enabled automatically. For external scripts, you need to enable it manually.
响应处理程序脚本和预请求脚本是用 JavaScript ECMAScript 2023 编写的，使用捆绑的 HTTP Pre-Request and Response Handler 库进行编码辅助和文档处理。对于原地脚本，此功能会自动启用。对于外部脚本，您需要手动启用。

The HTTP Response Handler library exposes two objects to be used for composing response handler scripts:
HTTP Response Handler库公开了两个对象，用于组合响应处理程序脚本：

Response handler scripts can include tests, which lets you use the HTTP Client as a testing framework. To create a test, invoke the client.test(testName, function) method. Inside the test, you can assert a condition by invoking the client.assert(condition, message) method, for example:
响应处理脚本可以包含测试，使您可以将 HTTP 客户端用作测试框架。要创建一个测试，请调用 client.test(testName, function) 方法。在测试中，您可以通过调用 client.assert(condition, message) 方法来断言一个条件，例如：

GET https://httpbin.org/status/200

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

Execute HTTP requests 执行 HTTP 请求

View responses from web services
查看来自网络服务的响应

Extract data from JSON response using JSONPath

jsonPath(ObjectToParse, JSONPathExpression)

Use the jsonPath live template to quickly insert this function.

After the request, in the response handler script part, start typing > jsonPath.
Press ↩Enter to expand the live template and complete the JSONPath expression.
For example, this expression will retrieve and print the value of the title field of the first element within the slides array, which is a part of the slideshow object:
```
GET https://examples.http-client.intellij.net/json

> {%
    client.log(jsonPath(response.body, "$.slideshow.slides[0].title",))
%}
```
Preview the obtained value in the Response Handler tab of the Services tool window.

Extract data from XML response using XPath
使用 XPath 从 XML 响应中提取数据

In your response handler script, use the following function:
在你的响应处理程序中，使用下面的函数：
```
xpath(XMLToParse, XPathExpression)
```
In XMLToParse enter the XML content to be parsed (for example, response.body), and in XPathExpression enter your XPath expression.
在 XMLToParse 中输入要解析的 XML 内容（例如，response.body），并在 XPathExpression 中输入您的 XPath 表达式。

GET https://examples.http-client.intellij.net/xml

> {%
    client.log(xpath(response.body, '//slide[@type="all"][1]/title/text()'))
%}

View request history

Manage cookies 管理 cookie

If you want a cookie to never expire, you can enter -1 as the date parameter. For example:
如果您希望 cookie 永不过期，您可以将-1输入为日期参数。例如：

# domain path name value date

.example.com / userId 0x4d2 -1

If you want to set custom cookies in an HTTP request, you can use the Cookie header. Enter your cookies as a list of name=value pairs separated by a semicolon, for example:

GET http://localhost:80/api
Cookie: theme=dark; country=France

gRPC requests

The HTTP Client supports gRPC requests. For the HTTP Client to treat your requests as gRPC requests, start them with the GRPC keyword.

Based on a .proto file, IntelliJ IDEA provides completion for gRPC: all known gRPC services, unary and server-streaming methods of a particular server, and fields of accepted messages in the request body. If you don’t have a .proto file in your project, code completion can still be available if a server supports gRPC reflection, which provides HTTP clients with information about accessible services.

Send gRPC metadata 发送 gRPC 元数据

Below your GRPC request, enter gRPC metadata using the following syntax: Metadata-key: Value.
在您的 GRPC 请求下，使用以下语法输入 gRPC 元数据：Metadata-key: Value。
For example: 例如：
```
GRPC localhost:8080
X-Myhostname: Example.org
```

Use secure gRPC 使用安全的 gRPC

WebSocket requests WebSocket 请求

The HTTP Client supports WebSocket requests. For the HTTP Client to treat your request as a WebSocket request, start it with the WEBSOCKET keyword followed by a server address. The request has the following structure:
HTTP Client 支持 WebSocket 请求。为了使 HTTP 客户端将您的请求视为 WebSocket 请求，请以服务器地址后面跟随 WEBSOCKET 关键字来启动它。请求具有以下结构：

WEBSOCKET ws://localhost:8080/websocket
Content-Type: application/json // Used for content highlighting only

// Request body, for example:
{
  "message": "First message sent on connection"
}
===  // message separator
{
  "message": "Second message" // will be sent right after the previous one
}
=== wait-for-server  // keyword used to wait for the server response
{
  "message": "Send this after the server response"
}

Send multiple messages 发送多条信息

Use the === separator to send multiple messages:
使用===分隔符发送多个消息：

{
  "message": "First message sent on connection"
}
===  // message separator
{
  "message": "Second message"
}
===
{
  "message": "Third message"
}

Send messages after the server response
服务器响应后发送消息

Before a message, enter === wait-for-server.
在发送消息前，请输入 === wait-for-server。
This will make the HTTP Client wait for the server response before sending the message. You can wait for multiple responses by repeating the === wait-for-server line. For example, the following message will be sent after 3 server responses:
这将使 HTTP 客户端在发送消息之前等待服务器响应。您可以通过重复=== wait-for-server行来等待多个响应。例如，以下消息将在 3 个服务器响应之后发送：
```
=== wait-for-server
=== wait-for-server
=== wait-for-server
{
  "message": "This messages is sent after 3 server responses"
}
```

GraphQL

Compose an HTTP request with GraphQL query
使用 GraphQL 查询构建一个 HTTP 请求

In an .http file, enter the GRAPHQL keyword followed by a server address.
在一个.http文件中，输入GRAPHQL关键字，后跟服务器地址。
In the request body, compose your GraphQL operation (query, mutation, or subscription), for example:
在请求体中，编写您的 GraphQL 操作（查询、变异或订阅），例如：
```
### HTTP request with GraphQL query
GRAPHQL http://localhost:8080/graphql

query {
  toDos {
    title,
    completed,
    author {
      username
    }
  }
}
```

Use GraphQL variables 使用 GraphQL 变量

After the query part, enter a JSON variables dictionary:
在查询部分之后，输入一个 JSON 变量字典：
```
query ($name: String!, $capital: String!) {
  country(name: $name, capital: $capital) {
    name
    capital
  }
}

{
  "name": "France",
  "capital": "Paris"
}
```
You can also use HTTP Client environment variables as GraphQL variable values. For example, in this JSON, "{{Author}}" is an environment variable; its value at runtime depends on the environment that you select while sending the request:
您还可以将HTTP Client 环境变量作为 GraphQL 变量值使用。例如，在此 JSON 中，"{{Author}}"是一个环境变量；它在运行时的值取决于您在发送请求时选择的环境：
```
{
  "author": "{{Author}}"
}
```

Configure proxy settings 配置代理设置

Set up client SSL/TLS certificate
设置客户端 SSL/TLS 证书

Specify path to certificate
指定证书路径

In an .http file, in the Run with list, select Add Environment to Private File.

In the http-client.private.env.json file that opens, add the SSLConfiguration object to the needed environment. In clientCertificate, enter a path to your client certificate. If a certificate key is stored in a separate file, enter its path in clientCertificateKey. For example:

{
    "dev": {
        "MyVar": "SomeValue",
        "SSLConfiguration": {
            "clientCertificate": "cert.pem",
            "clientCertificateKey": "MyFolder/key.pem"
        }
    }
}

tip
You can specify an absolute path or a path relative to the http-client.private.env.json file. If the environment file is stored in scratches, you can additionally specify a path relative to your project root. Start typing a path to get the code completion popup.

Alternatively, you can describe clientCertificate and clientCertificateKey as objects, which lets you specify the certificate format in addition to the path. For example:

{
    "dev": {
        "SSLConfiguration": {
            "clientCertificate": {
                "path": "file.crt",
                "format": "PEM"
            },
            "clientCertificateKey": {
                "path": "file.key",
                "format": "DER"
            }
        }
    }
}

Set up a certificate passphrase

In the http-client.private.env.json file, add "hasCertificatePassphrase": true to the SSLConfiguration object, for example:

{
    "dev": {
        "SSLConfiguration": {
            "clientCertificate": "file.crt",
            "hasCertificatePassphrase": true
        }
    }
}

Click in the gutter or, with the caret placed at hasCertificatePassphrase, press ⌥ Option↩Enter and select Set value for 'Certificate passphrase'.
In the window that opens, enter your certificate passphrase.

Disable certificate verification

In the http-client.private.env.json file, add verifyHostCertificate": false to the SSLConfiguration object. For example:

{
    "sslTest": {
        "SSLConfiguration": {
            "verifyHostCertificate": false
        }
    }
}

HTTP Client HTTP 客户端

See also

Procedures

HTTP Client HTTP 客户端﻿

Create HTTP request files创建 HTTP 请求文件﻿

Create an HTTP request scratch file创建一个 HTTP 请求的刮痕文件﻿

Create a physical HTTP request file创建一个物理的 HTTP 请求文件﻿

Move an HTTP request 移动一个 HTTP 请求﻿

Compose HTTP requests 编写 HTTP 请求﻿

tip 小费

note 笔记

tip 提示

Create custom HTTP methods创建自定义的 HTTP 方法﻿

HTTP/2﻿

Select HTTP version 选择 HTTP 版本﻿

Open a request from the HTTP Requests Collection从 HTTP 请求集合打开一个请求﻿

note 注意

Convert cURL requests 转换 cURL 请求﻿

Convert cURL to HTTP request将 cURL 转换为 HTTP 请求﻿

Convert HTTP request to cURL将 HTTP 请求转换为 cURL﻿

Import Postman collections and environments导入 Postman 集合和环境﻿

Import Postman collections to HTTP Client将 Postman 集合导入到 HTTP 客户端﻿

note 注意

Generate requests using context action使用上下文操作生成请求﻿

Create requests from OpenAPI specifications从 OpenAPI 规范创建请求﻿

Create an HTTP request to an endpoint创建一个 HTTP 请求到一个终端点﻿

tip 提示

Rename an endpoint and its usages重命名一个端点及其用法﻿

Use response handler and pre-request scripts使用响应处理程序和预请求脚本﻿

Insert response handler scripts插入响应处理程序脚本﻿

Insert pre-request scripts插入预请求脚本﻿

Import JavaScript code 导入 JavaScript 代码﻿

note 注意

Enable JavaScript coding assistance for response handler and pre-request scripts为响应处理程序和预请求脚本启用 JavaScript 编码辅助﻿

Navigate through .http file using the Structure tool window使用结构工具窗口导航 .http 文件﻿

Execute HTTP requests 执行 HTTP 请求﻿

Execute single request 执行单个请求﻿

Execute multiple requests sequentially依次执行多个请求﻿

Open a request in the browser在浏览器中打开一个请求﻿

Work with HTTP request run/debug configurations使用 HTTP 请求运行/调试配置﻿

Modify an HTTP Request run/debug configuration修改一个 HTTP 请求运行/调试配置﻿

Save a temporary HTTP Request run/debug configuration保存临时的 HTTP 请求运行/调试配置﻿

Execute a request using a run/debug configuration使用运行/调试配置执行请求﻿

View responses from web services查看来自网络服务的响应﻿

View a received response 查看收到的回复﻿

Open a response file in the editor﻿

Extract data from JSON response using JSONPath﻿

Extract data from XML response using XPath使用 XPath 从 XML 响应中提取数据﻿

Compare responses in a scratch file在一个刮擦文件中比较响应﻿

Compare responses in the request history﻿

View request history﻿

note

Open request history 打开请求历史﻿

Redirect output to a custom file or directory将输出重定向到自定义文件或目录﻿

Manage cookies 管理 cookie﻿

note

gRPC requests﻿

note 笔记

Generate a gRPC request from proto files从 proto 文件生成一个 gRPC 请求﻿

Generate a gRPC request from Endpoints tool window从 Endpoints 工具窗口生成 gRPC 请求﻿

Send gRPC metadata 发送 gRPC 元数据﻿

Use secure gRPC 使用安全的 gRPC﻿

tip 提示

note 笔记

WebSocket requests WebSocket 请求﻿

note 注意

Send multiple messages 发送多条信息﻿

Send messages after the server response服务器响应后发送消息﻿

Send messages interactively发送信息互动地﻿

GraphQL﻿

tip 小费

Compose an HTTP request with GraphQL query使用 GraphQL 查询构建一个 HTTP 请求﻿

Use GraphQL variables 使用 GraphQL 变量﻿

note 注意

Create GraphQL request from Spring controller从 Spring 控制器创建 GraphQL 请求﻿

tip 提示

Configure proxy settings 配置代理设置﻿

Set up client SSL/TLS certificate设置客户端 SSL/TLS 证书﻿

tip 小费

Specify path to certificate指定证书路径﻿

tip

Set up a certificate passphrase﻿

Disable certificate verification﻿

HTTP Client HTTP 客户端

Create HTTP request files
创建 HTTP 请求文件

Create an HTTP request scratch file
创建一个 HTTP 请求的刮痕文件

Create a physical HTTP request file
创建一个物理的 HTTP 请求文件

Move an HTTP request 移动一个 HTTP 请求

Compose HTTP requests 编写 HTTP 请求

Create custom HTTP methods
创建自定义的 HTTP 方法

HTTP/2

Select HTTP version 选择 HTTP 版本

Open a request from the HTTP Requests Collection
从 HTTP 请求集合打开一个请求

Convert cURL requests 转换 cURL 请求

Convert cURL to HTTP request
将 cURL 转换为 HTTP 请求

Convert HTTP request to cURL
将 HTTP 请求转换为 cURL

Import Postman collections and environments
导入 Postman 集合和环境

Import Postman collections to HTTP Client
将 Postman 集合导入到 HTTP 客户端

Generate requests using context action
使用上下文操作生成请求

Create requests from OpenAPI specifications
从 OpenAPI 规范创建请求

Create an HTTP request to an endpoint
创建一个 HTTP 请求到一个终端点

Rename an endpoint and its usages
重命名一个端点及其用法

Use response handler and pre-request scripts
使用响应处理程序和预请求脚本

Insert response handler scripts
插入响应处理程序脚本

Insert pre-request scripts
插入预请求脚本

Import JavaScript code 导入 JavaScript 代码

Enable JavaScript coding assistance for response handler and pre-request scripts
为响应处理程序和预请求脚本启用 JavaScript 编码辅助

Navigate through .http file using the Structure tool window
使用结构工具窗口导航 .http 文件

Execute HTTP requests 执行 HTTP 请求

Execute single request 执行单个请求

Execute multiple requests sequentially
依次执行多个请求

Open a request in the browser
在浏览器中打开一个请求

Work with HTTP request run/debug configurations
使用 HTTP 请求运行/调试配置

Modify an HTTP Request run/debug configuration
修改一个 HTTP 请求运行/调试配置

Save a temporary HTTP Request run/debug configuration
保存临时的 HTTP 请求运行/调试配置

Execute a request using a run/debug configuration
使用运行/调试配置执行请求

View responses from web services
查看来自网络服务的响应

View a received response 查看收到的回复

Open a response file in the editor

Extract data from JSON response using JSONPath

Extract data from XML response using XPath
使用 XPath 从 XML 响应中提取数据

Compare responses in a scratch file
在一个刮擦文件中比较响应

Compare responses in the request history

View request history

Open request history 打开请求历史

Redirect output to a custom file or directory
将输出重定向到自定义文件或目录

Manage cookies 管理 cookie

gRPC requests

Generate a gRPC request from proto files
从 proto 文件生成一个 gRPC 请求

Generate a gRPC request from Endpoints tool window
从 Endpoints 工具窗口生成 gRPC 请求

Send gRPC metadata 发送 gRPC 元数据

Use secure gRPC 使用安全的 gRPC

WebSocket requests WebSocket 请求

Send multiple messages 发送多条信息

Send messages after the server response
服务器响应后发送消息

Send messages interactively
发送信息互动地

GraphQL

Compose an HTTP request with GraphQL query
使用 GraphQL 查询构建一个 HTTP 请求

Use GraphQL variables 使用 GraphQL 变量

Create GraphQL request from Spring controller
从 Spring 控制器创建 GraphQL 请求

Configure proxy settings 配置代理设置

Set up client SSL/TLS certificate
设置客户端 SSL/TLS 证书

Specify path to certificate
指定证书路径

Set up a certificate passphrase

Disable certificate verification