HTTP 客户端

创建 HTTP 请求临时文件

• 按下 Ctrl+Alt+Shift+Insert 并选择 HTTP 请求。

创建实体 HTTP 请求文件

• 在 文件 菜单中，指向 新建 ，然后点击 HTTP 请求。

移动 HTTP 请求

您可以使用 移动重构 F6 将 HTTP 请求从临时文件移动到物理文件，也可在物理文件之间移动。

1. 在编辑器中，将插入符放在要移动的请求上，然后执行以下操作之一：

   • 在主菜单或上下文菜单中，选择 重构 | 移动。

   • 按下 Alt+Enter 并选择 移动HTTP 请求 意图操作。

   • 按 F6。

2. 在打开的 移动HTTP 请求 对话框中，执行以下操作：

   1. 在 路径 字段中，从列表中选择现有的 .http 文件之一，或点击 以定位该文件。

      您还可以手动输入文件的完整路径。 如果指定的文件名不存在，将自动创建一个具有该名称的新文件。

   2. 在 请求 列表中，选中要移动的请求旁边的复选框。

创建自定义 HTTP 方法

如果某个 Web 服务要求使用自定义 HTTP 方法，您可以将这些方法添加到 GoLand 中并在 HTTP 请求中使用它们。

1. 在 .http 文件中，以大写字母输入自定义方法。

2. 当该方法被标记为未知时，按 Alt+Enter （显示上下文操作 ），然后选择 添加自定义 HTTP 方法。

GoLand 现在会将其识别为有效的 HTTP 方法。 您可以在 IDE 设置（Ctrl+Alt+S ）的 工具 | HTTP 客户端 | 自定义 HTTP 方法 部分查找所有自定义 HTTP 方法并添加新方法。

从 HTTP 请求集合中打开请求

1. 点击请求编辑器面板顶部的 示例 快捷链接。

2. 在弹出菜单中，选择要打开的 HTTP 请求集合：

   

使用结构工具窗口浏览 .http 文件

如果在 .http 文件中包含多个请求，可以使用 结构 工具窗口快速预览文件并进行导航。 该工具窗口还会显示请求的组成部分，比如 headers、请求正文、预处理脚本和响应处理脚本。

1. 打开 结构 工具窗口： 视图 | 工具窗口 | 结构。

   或者，按 Alt+7。

2. 在 结构 工具窗口中，点击 HTTP 方法、请求名称或请求的任意部分。

您也可以通过右键点击并选择 来进行发送请求。

执行单个请求

1. 如果您要测试自己的 Web 服务，请确保该服务已部署并正在运行。

2. 如果已定义 环境 ，请在请求编辑器面板顶部的 运行方式 列表中选择一个环境。

3. 在边栏中，点击紧邻请求的 。

依次执行多个请求

您可以一次性运行 .http 文件中的所有请求。 这对于复杂场景非常有用，例如从服务器请求特定数据，将其保存为 client.global 变量，并发送包含该数据的后续请求。

1. 打开一个 .http 文件。

2. 在编辑器面板顶部，点击 （运行文件中的所有请求）。

在浏览器中打开请求

您可以在 Web 浏览器与预览 页的 设置 对话框中指定的浏览器中打开 HTTP 请求（Ctrl+Alt+S）。

• 按 Alt+Enter 并选择 在Web 浏览器中打开 意图操作。

从其他 .http 文件中运行所有请求

1. 在您的 .http 文件中，输入 run ，后接要包含的另一个 .http 的名称。 如果文件位于同一目录中，请输入其名称。 否则，请指定其路径。 例如：

   run ./myFolder/get-requests.http

2. 单击 （位于 run 旁边）以发送此文件中的所有请求。

从其他 .http 文件中运行特定请求

1. 在您的 .http 文件顶部，输入 import ，后接包含必要请求的另一个 .http 的名称。

2. 输入 run 并指定要运行的请求名称。

   您可以按 Ctrl+Space 查看导入文件中可用的所有请求。

   

覆盖从 .http 文件导入的变量

如果导入的 .http 文件包含变量，您可以为特定执行指定或更改其值。

1. 输入 run 并指定 .http 文件或请求的名称。

2. 在请求或文件名称之后，以 (@variable=value) 格式输入变量。 如需指定多个变量，请使用顿号分隔它们。 例如：

   import new-requests.http run #GET request with one var (@host=example.com) run #GET request with two vars (@host=example.com, @user=userName)

查看接收到的响应

1. 切换到 服务工具窗口 ，在收到响应后此窗口将自动打开。

2. 默认情况下，服务器响应以请求头中的 content-type 字段指定的格式显示。 如需将响应转换为其他格式，请单击 ，然后选择 文本、 JSON、 XML 或 HTML。

   

如果响应包含二进制文件，则此文件也会保存到 .idea/httpRequests/ 目录下。 如果响应是图像、PDF 或 HTML 文件，您可以在 IDE 中直接进行预览。

在 服务 工具窗口中预览图像：

在 服务 工具窗口中预览 PDF 文件。 如需禁用在 服务 工具窗口中显示 PDF 预览，请单击 并取消选中 启用 PDF 行内预览 选项。

如果响应是 HTML 文件，您可以单击 显示预览 ，使用基于 JCEF 的浏览器在编辑器选项卡中预览它。

如果您有 响应处理脚本 ，在此脚本中执行的测试结果将显示在 测试 选项卡中的 服务 工具窗口里。 您可以单击每个测试，快速跳转到相应响应处理脚本中的测试源码。

如果您订阅了事件流，GoLand 会在 服务 工具窗口中显示事件。 在此，您还可以查看客户端与服务器的连接状态，并单击 终止连接。 根据内容类型（text/event-stream 或 application/x-ndjson ），响应内容会以纯文本或换行符分隔的 JSON 格式呈现。 您可以编写响应处理脚本来 处理事件流中的每一行。

当前不支持将 事件流重定向到文件。

在编辑器中打开响应文件

1. 将插入符号放在要打开的响应链接上。

2. 请执行以下任一操作：

   • 在主菜单中，转到 视图 | 跳转到源代码。

   • 按 Ctrl+B 或 F4。

   • 在 服务 工具窗口或编辑器中（对于临时文件）， Ctrl+Click 响应行中的链接。

使用 JSONPath 从 JSON 响应中提取数据

HTTP Client 支持 JSONPath 查询功能，使您能够解析并提取接收到的 JSON 文档中的数据。 为此，请在 响应处理脚本中使用以下函数：

使用 jsonPath 代码模板可以快速插入此函数。

1. 请求之后，在响应处理脚本部分开始输入 > jsonPath。

2. 按 Enter 展开代码模板并完成 JSONPath 表达式。

   例如，此表达式将检索并打印 slideshow 对象中 slides 数组内第一个元素的 title 字段值：

   GET https://examples.http-client.intellij.net/json > {% client.log(jsonPath(response.body, "$.slideshow.slides[0].title",)) %}

   在 响应处理器 选项卡中的 服务 工具窗口里预览所获取的值。

使用 XPath 从 XML 响应中提取数据

HTTP Client 支持 XPath 表达式，使您可以解析并提取接收到的 XML 文档中的数据。

1. 在 响应处理脚本中使用以下函数：

   xpath(XMLToParse, XPathExpression)

2. 在 XMLToParse 中输入要解析的 XML 内容（例如 response.body ），并在 XPathExpression 中输入 XPath 表达式。

例如：

在临时文件中比较响应

从临时文件执行请求时，响应输出文件的链接将添加在原始请求下方。

• 请执行以下任一操作：

  • 将插入符号放在响应文件的链接上。 按 Alt+Enter 并选择 与 <response name> 比较 意图操作。

  • 单击页边空白处的 ，然后从列表中选择 与 <response name> 比较：

    

在请求历史记录中比较响应

从物理文件执行请求时，响应输出链接将添加到 请求历史中。

1. 将插入符号放在响应文件的链接上。 在主菜单中进入 视图 | 跳转到源代码 ，或按 Ctrl+B 或 F4 在新的编辑器标签页中打开该文件。

2. 在主菜单中进入 视图 | 进行比较 ，或按 Ctrl+D。 GoLand 会提示您从 httpRequests 文件夹中打开响应文件。

3. 选择要与当前文件进行比较的响应文件，然后单击 打开。

两个响应文件将在 差异查看器 中打开，以便比较它们的内容：

打开请求历史记录

• 单击请求编辑器面板顶部的 。

• 在主菜单中选择 工具 | HTTP 客户端 | 显示HTTP 请求历史记录。

将输出重定向到自定义文件或目录

• HTTP Client 可将输出重定向到自定义文件或目录。 它支持两个强制与非强制重定向运算符：

  • >> 运算符始终创建新文件，如果目标文件名已存在，则添加 -n 后缀。

  • >>! 运算符在文件已存在时会覆盖该文件。

从 proto 文件生成 gRPC 请求

• 在 proto 文件中，点击 RPC 方法旁边的 在HTTP 客户端中生成请求。

  

从 Endpoints 工具窗口生成 gRPC 请求

与处理 HTTP 请求一样，您也可以使用 端点 工具窗口生成 gRPC 请求。

1. 打开 端点 工具窗口： 视图 | 工具窗口 | 端点。 如果项目中定义了 gRPC 端点，您将在此看到这些端点。

2. 选择一个端点。 这将在 HTTP 客户端 选项卡中生成一个示例请求。

3. 完成请求后点击 提交请求。 您可能需要将默认地址和端口替换为您自己的值。 对于请求正文，请根据 proto 文件中的数据结构使用代码补全功能。

4. 在 HTTP 客户端 选项卡的下方预览响应内容。

发送 gRPC 元数据

• 在 GRPC 请求下方，使用以下语法输入 gRPC 元数据： Metadata-key: Value。

  例如：

  GRPC localhost:8080 X-Myhostname: Example.org

使用安全 gRPC

您可以发起由服务器端 TLS 保护的连接。

• 在地址前输入 grpcs ，例如：

  GRPC grpcs://ijhttp-examples.jetbrains.com/hello.HelloService/SayHello

从 PROTO 文件导航到 Go 代码

• 您可以从 Go 代码导航并访问消息、服务和方法的声明，也可以从 PROTO 文件导航至它们在 Go 中的实现。

  点击消息、服务或方法声明或其实现旁的 导航到实现 图标。

发送多个消息

• 使用 === 分隔符以发送多个消息：

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

在服务器响应后发送消息

• 在消息前输入 === wait-for-server。

  这将使 HTTP Client 在发送消息之前等待服务器响应。 如果重复添加 === wait-for-server 行，您可以等待多个响应。 例如，以下消息将在收到 3 条服务器响应之后发送：

  === wait-for-server === wait-for-server === wait-for-server { "message": "This messages is sent after 3 server responses" }

交互式发送消息

启动连接后，您可以直接在 服务 工具窗口中与服务器交互。 您可以发送消息并查看服务器对每条新消息的响应。

1. 在 服务 工具窗口中，选择一个已打开的连接。

2. 在窗口下方的 要发送到 WebSocket 的消息 部分中输入消息内容。

3. 在其右侧选择消息格式：纯文本、JSON、XML 或 HTML。

4. 按 Ctrl+Enter 发送请求。

在窗口顶部，您将看到服务器响应。

使用 GraphQL 查询构造 HTTP 请求

1. 在 .http 文件中，输入 GRAPHQL 关键字，并紧跟服务器地址。

2. 在请求正文中编写您的 GraphQL 操作（query、mutation 或 subscription），例如：

   ### HTTP request with GraphQL query GRAPHQL http://localhost:8080/graphql query { toDos { title, completed, author { username } } }

为加快编写包含 GraphQL 查询的 HTTP 请求，您可以：

• 点击 ，位于 .http 文件的编辑面板上方，然后选择 GraphQL 查询请求。

• 在 .http 文件中键入 gqlr ，然后按 Enter 应用 GraphQL 代码模板。

使用 GraphQL 变量

在 HTTP 请求体中，如果希望将部分动态数据与查询字符串分开传递，您可以使用 GraphQL 变量。

• 在查询部分之后，输入一个 JSON 变量字典：

  query ($name: String!, $capital: String!) { country(name: $name, capital: $capital) { name capital } } { "name": "France", "capital": "Paris" }

  您还可以使用 HTTP Client 环境变量 作为 GraphQL 变量的值。 例如，在此 JSON 中， "{{Author}}" 是一个环境变量；其运行时的值取决于您在发送请求时所选的环境：

  { "author": "{{Author}}" }

1. 在 设置 对话框（Ctrl+Alt+S ）中，在 外观与行为 下选择 系统设置 ，然后选择 HTTP 代理。

2. 在打开的 HTTP Proxy 对话框中，选择 手动代理配置 ，然后指定以下内容：

   • 在 主机名 和 端口号 字段中输入代理主机名和端口号。

   • 要启用身份验证，请选中 代理身份验证 复选框，并在相应的字段中输入用户名和密码。

指定证书路径

1. 在 .http 文件中，在 运行方式 列表中选择 将环境添加到Private 文件…。

2. 在打开的 http-client.private.env.json 文件中，将 SSLConfiguration 对象添加到所需环境中。 在 clientCertificate 中输入客户端证书的路径。 如果证书密钥存储在单独的文件中，请在 clientCertificateKey 中输入其路径。 例如：

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

   或者，您也可以将 clientCertificate 和 clientCertificateKey 描述为对象，这样即可在指定路径的同时指定证书格式。 例如：

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

设置证书密码

如果在生成客户端证书时使用了密码短语，则应将其提供给 HTTP Client。

1. 在 http-client.private.env.json 文件中，将 "hasCertificatePassphrase": true 添加到 SSLConfiguration 对象中，例如：

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

2. 单击侧边栏中的 ，或将插入符号放在 hasCertificatePassphrase 处时按 Alt+Enter 并选择 设置'Certificate passphrase' 的值。

3. 在打开的窗口中，输入证书的密码短语。

   

如果暂时不想输入密码短语，您可以省略第二步。 在这种情况下，GoLand 会在您执行 HTTPS 请求时提示输入密码短语。

禁用证书验证

在进行开发时，您可能会使用带有自签名或已过期证书的主机。 如果您信任该主机，可以禁用其证书的验证。

• 在 http-client.private.env.json 文件中，将 verifyHostCertificate": false 添加到 SSLConfiguration 对象中。 例如：

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

如果您使用该环境运行请求，GoLand 将不会验证主机证书。