HTTP 客户端

创建临时 HTTP 请求文件

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

创建物理 HTTP 请求文件

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

移动 HTTP 请求

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

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

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

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

   • 按下 F6。

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

   1. 在 路径 字段中，从列表中选择一个已有的 .http 文件，或单击 定位该文件。

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

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

   

创建自定义 HTTP 方法

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

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

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

现在，WebStorm 会将其识别为有效的 HTTP 方法。 您可以在 IDE 设置（Ctrl+Alt+S ）中的 工具 | HTTP Client | 自定义 HTTP 方法 查看所有自定义 HTTP 方法（并添加新的方法）。

从 HTTP 请求集合中打开请求

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

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

   

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

如果在 .http 文件中包含多个请求， 结构 工具窗口可帮助您快速预览文件并在其中导航。 该工具窗口还显示请求部分，例如标头、请求正文、前置请求脚本以及响应处理脚本。

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

   或者，按下 Alt+7。

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

您还可以在该处右键点击请求并选择 来发送请求。

执行单个请求

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

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

3. 在标号区中，点击请求旁的 。

按顺序执行多个请求

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

1. 打开一个 .http 文件。

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

从另一个 .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 的浏览器进行预览。

如果您有一个 response handler script ，作为该脚本一部分执行的测试结果将在 测试 标签页的 服务 工具窗口中显示。 您可以点击每个测试，快速导航到相应 response handler script 中的测试源代码。

如果您订阅了事件流，WebStorm 会在 服务 工具窗口中显示事件。 在此，您还可以查看客户端与服务器之间连接的状态，并点击 来终止连接。 根据内容类型（text/event-stream 或 application/x-ndjson ），响应将被格式化为纯文本或按行分隔的 JSON。 您可以编写一个 response handler script 来 逐行处理事件流。

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

在编辑器中打开响应文件

1. 将光标放置在要打开的响应链接上。

2. 执行以下操作之一：

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

   • 按 Ctrl+B 或 F4。

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

     

     

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

HTTP Client 支持 JSONPath 查询，允许您从收到的 JSON 文档中解析并提取数据。 为此，请在 response handler script 中使用以下函数：

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

1. 请求后，在 response handler script 部分中开始键入 > 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. 在 response handler script 中使用以下函数：

   xpath(XMLToParse, XPathExpression)

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

例如：

在临时文件中比较响应

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

• 执行以下任一操作：

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

  • 点击边距中的 ，并从列表中选择 与 <response name> 比较：

    

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

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

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

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

3. 选择要与当前文件进行比较的响应文件并点击 打开。

两个响应文件将会在 Diff Viewer 中打开，允许您比较其内容：

打开请求历史记录

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

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

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

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

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

  • 如果文件已存在， >>! 运算符将覆盖该文件。

开始之前

• 在 设置 | 插件 页面上的 Marketplace 选项卡中安装 Protocol Buffers 和 gRPC 插件，如 从 JetBrains Marketplace 安装插件 中所述。

从 proto 文件生成 gRPC 请求

• 在 proto 文件中，点击 RPC 方法旁的 在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" }

服务器响应后发送消息

• 在消息前输入 === 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 操作（查询、变更或订阅），例如：

   ### 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. 在打开的窗口中输入您的证书密钥短语。

   

如果您现在不希望输入密钥短语，可以省略第二步。 在这种情况下，WebStorm 会在执行 HTTPS 请求时提示您输入密钥短语。

禁用证书验证

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

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

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

如果在该环境中运行请求，WebStorm 将不会验证主机证书。