HTTP 客户端

创建 HTTP 请求 草稿文件

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

• 在解决方案窗口中切换到 草稿 视图，右键单击要添加请求文件的文件夹，并从上下文菜单中选择 添加 | HTTP 请求。

创建一个物理 HTTP 请求文件

• 右键单击要添加请求文件的文件夹，并从上下文菜单中选择 添加 | HTTP 请求。

移动 HTTP 请求

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

1. 在编辑器中，将文本光标置于要移动的请求处，然后执行以下操作之一：

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

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

   • 按下 F6。

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

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

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

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

创建自定义 HTTP 方法

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

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

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

JetBrains Rider 将现在识别它为有效的 HTTP 方法。 您可以在 IDE 设置中(Ctrl+Alt+S)， 工具 | HTTP 客户端 | 自定义 HTTP 方法 找到所有自定义 HTTP 方法（并添加新方法）。

从 HTTP 请求集合中打开请求

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

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

   

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

如果您的 .http 文件中有多个请求， 结构 工具窗口可以帮助您快速预览文件并进行导航。 工具窗口还显示请求部分，例如 标头、请求正文、预请求处理脚本 和 响应处理程序脚本。

1. 打开 结构 工具窗口： 查看 | 工具窗口 | 结构。

   或者按 Alt+7。

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

您还可以通过右键点击它并选择 从那里发送请求。

执行单个请求

1. 如果您打算测试自己的 Web 服务，请确保其已部署并运行。

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

3. 在边距中，点击请求旁的 。

顺序执行多个请求

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

1. 打开文件 .http 。

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

在浏览器中打开请求

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

• 按 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 的浏览器预览它。

如果您有一个 响应处理脚本 ，作为该脚本一部分执行的测试结果将显示在 服务 工具窗口的 测试 选项卡中。 您可以点击每个测试，以快速导航到相应响应处理脚本中的测试源代码。

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

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

在编辑器中打开响应文件

1. 将文本光标放在您要打开的响应链接处。

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

   • 在主菜单中，进入 查看 | 跳转到源代码.

   • 按 Ctrl+B 或 F4。

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

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

HTTP 客户端 支持 JSONPath 查询，使您能够解析和提取接收到的 JSON 文档的数据。 要做到这一点，请在您的 响应处理程序脚本中使用以下功能：

请使用 jsonPath 实时模板 快速插入此函数。

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

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

   例如，此表达式将检索并打印第一个元素内的 幻灯片 数组的 标题 字段的值，该数组是 幻灯片放映 对象的一部分：

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

   在 响应处理程序 选项卡中预览所获取的值，位于 服务 工具窗口中。

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

HTTP 客户端 支持 XPath 表达式，允许您解析和提取接收到的 XML 文档中的数据。

1. 在您的 响应处理程序脚本中，请使用以下函数：

   xpath(XMLToParse, XPathExpression)

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

例如：

在临时文件中比较响应

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

• 执行以下任意操作：

  • 将文本光标放在响应文件链接处。 按 Alt+Enter 并选择 与 <response name> 比较 意图操作。

  • 点击 图标并从列表中选择 与 <response name> 比较：

    

在请求历史中比较响应

当从物理文件执行请求时，响应输出的链接会添加到 requests' history 中。

1. 将文本光标放在响应文件链接处。 在主菜单中，进入 查看 | 跳转到源代码 ，或者按 Ctrl+B 或 F4 以在新的编辑器选项卡中打开此文件。

2. 请前往 查看 | 比较 与 ，或按下 Ctrl+D。 JetBrains Rider 将提示您从 httpRequests 文件夹中打开一个响应文件。

3. 请选择您希望用于比较当前文件的响应文件，然后点击 打开。

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

打开请求历史

• 点击 位于请求编辑器面板的顶部。

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

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

• HTTP 客户端 可以将输出重定向到自定义文件或目录。 它支持两种强制和软重定向操作符：

  • >> 运算符总是会创建一个新文件，如果请求的文件名已经存在，则在文件名后添加一个 -n 后缀。

  • >>! 操作符会在文件已存在时重写文件。

从 proto 文件生成 gRPC 请求

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

  

从 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

发送多条消息

• 请使用 === 分隔符发送多条消息：

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

在服务器响应后发送消息

• 在消息之前，输入 === 等待服务器。

  这将使 HTTP 客户端 在发送消息之前等待服务器响应。 您可以通过重复 === 等待服务器 行等待多个响应。 例如，将在 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 操作（查询、变更或订阅），例如：

   ### 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 变量来传递一些与查询字符串分开的动态数据。

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

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

  您也可以将 HTTP 客户端环境变量 用作 GraphQL 变量值。 例如，在这个 JSON 中， "{{Author}}" 是一个环境变量；它在运行时的值取决于您在发送请求时选择的环境：

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

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

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

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

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

指定证书路径

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

2. 在打开的 http-client.private.env.json 文件中，将 SSL 配置 对象添加到所需的环境中。 在 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 客户端。

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

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

2. 点击 ，或在将文本光标置于 hasCertificatePassphrase 时，按 Alt+Enter 并选择 设置'Certificate passphrase' 的值。

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

   

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

禁用证书验证

出于开发目的，您可能有一个带有自签名或过期证书的主机。 如果您信任此主机，您可以禁用其证书的验证。

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

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

如果您在此环境中运行请求，JetBrains Rider 将不会验证主机证书。