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 方法，您可以将这些方法添加到 PyCharm，并在您的 HTTP 请求中使用它们。

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

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

此后，PyCharm 会将其识别为有效的 HTTP 方法。 您可以在 IDE 设置（Ctrl+Alt+S ）中的 工具 | HTTP 客户端 | 自定义 HTTP 方法 下找到所有自定义 HTTP 方法（并添加新的）。

从 HTTP 请求集合中打开请求

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

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

   

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

如果您的 .http 文件中包含多个请求， 结构 工具窗口可帮助您快速预览并浏览该文件。 该工具窗口还会显示请求的各个部分，例如标头、请求正文、预请求脚本和响应处理脚本。

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

   或者，按 Alt+7。

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

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

执行单个请求

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

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

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 的浏览器在编辑器选项卡中预览它。

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

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

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

在编辑器中打开响应文件

1. 将插入符号置于您要打开的响应的链接处。

2. 执行以下任一操作：

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

   • 按 Ctrl+B 或 F4。

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

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

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

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

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

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

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

   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 并选择 与 <响应名称> 比较 意图操作。

  • 在装订区域，点击 ，并从列表中选择 与 <响应名称> 比较：

    

在请求历史中比较响应

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

1. 将插入符号置于响应文件的链接处。 在主菜单中，转到 视图 | 跳转到源 ，或按 Ctrl+B 或 F4 以在新的编辑器选项卡中打开该文件。

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

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

这两个响应文件将在 Diff Viewer 中打开，便于您比较其内容：

打开请求历史

• 在请求的编辑器面板顶部，点击 。

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

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

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

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

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

发送多条消息

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

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

在服务器响应后发送消息

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

  这将使 HTTP 客户端在发送该消息之前等待服务器响应。 您可以通过重复 === 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 environment variables 作为 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 客户端。

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

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

2. 在装订区域，点击 ，或者将插入符号置于 hasCertificatePassphrase 处，按 Alt+Enter 并选择 设置'Certificate passphrase' 的值。

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

   

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

禁用证书验证

为开发目的，您可能有一个使用自签名或过期证书的主机。 如果您信任该主机，您可以禁用对其证书的验证。

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

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

如果您使用此环境执行请求，PyCharm 将不会验证主机证书。