HTTP Client | PyCharm Documentation

创建HTTP请求文件

编写 HTTP 请求

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

Request-Body

在###分隔符之后，您可以输入前面带有#或的任何注释//。

或者，使用实时模板。在编辑器中，您可以按查看可用模板的列表。例如，gtr扩展为简单的 GET 请求；mptr扩展为POST 请求。Ctrl0Jmultipart/form-data

转换 cURL 请求

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'

# 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

###

选项	描述
-X，--请求	要使用的请求方法。
-H，--标题	要包含在请求中的请求标头。
-u，--用户 - 基本的 - 消化	随请求提供的用户凭据以及要使用的授权方法。
-d, --data, --data-ascii --数据二进制 --数据原始 --数据-urlencode	要在 POST 请求中发送的数据。
-F，--形式	要在 POST 请求中发送的多部分/表单数据消息。
--网址	要获取的 URL（主要在配置文件中指定 URL 时使用）。
-i，--包括	定义 HTTP 响应标头是否包含在输出中。
-v, --详细	启用详细操作模式。
-L, --位置	如果请求的页面已移动到其他位置，则可以重新发送请求。

使用响应处理程序和预请求脚本

插入响应处理程序脚本

要就地插入脚本，请在其前面添加>并将其括在中{% %}：
```
GET host/api/test

> {%
// Response Handler Script
...
%}
```
要从外部文件插入脚本，请在其前面添加>：
```
GET host/api/test

> scripts/my-script.js
```

插入预请求脚本

要就地插入脚本，请在其前面添加<并将其括在中{% %}：

< {%
    request.variables.set("petName", "Bella")
%}
POST https://example.org/pets/{{petName}}

要从外部文件插入脚本，请在其前面添加<：

< scripts/my-script.js

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

导入 JavaScript 代码

从 JavaScript 文件导出所需的值。HTTP Client 支持export以下格式的语句：

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 () { /* … */ }

将所需的值导入到响应处理程序或预请求脚本中。HTTP Client 支持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

笔记
如果您想从外部文件运行一些测试并且不需要从中导入任何内容，则可以在响应处理程序脚本中使用副作用导入，例如import 'test-scripts/mytests'. 如果您有通用测试并希望在多个请求中重用它们，同时又保留为某些请求编写（或导入）单独测试的能力，这可能会很有用。

响应处理程序脚本和预请求脚本是用 JavaScript ECMAScript 6 编写的，并提供由捆绑HTTP Pre-Request and Response Handler库处理的编码帮助和文档。对于就地脚本，此功能会自动启用。对于外部脚本，您需要手动启用它。

该HTTP Response Handler库公开了两个用于编写响应处理程序脚本的对象：

响应处理程序脚本可以包含测试，它允许您使用 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");
    });
%}

执行HTTP请求

查看来自 Web 服务的响应

查看请求历史记录

管理cookies

如果要在 HTTP 请求中设置自定义 cookie，可以使用Cookie标头。以分号分隔的成对列表形式输入您的 Cookie name=value，例如：

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

WebSocket 请求

HTTP 客户端支持 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"
}

发送多条消息

服务器响应后发送消息

在消息之前，输入=== 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"
}
```

GraphQL

使用 GraphQL 查询编写 HTTP 请求

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

在请求正文中，编写您的 GraphQL 操作（查询、变更或订阅），例如：

### HTTP request with GraphQL query
GRAPHQL http://localhost:8080/graphql

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

使用 GraphQL 变量

在查询部分之后，输入 JSON 变量字典：
```
query ($name: String!, $capital: String!) {
  country(name: $name, capital: $capital) {
    name
    capital
  }
}

{
  "name": "France",
  "capital": "Paris"
}
```
您还可以使用HTTP 客户端环境变量作为 GraphQL 变量值。例如，在此 JSON 中，"{{Author}}"是一个环境变量；它在运行时的值取决于您在发送请求时选择的环境：
```
{
  "author": "{{Author}}"
}
```

配置代理设置

设置客户端 SSL/TLS 证书

指定证书路径

在.http文件的“运行方式”列表中，选择“将环境添加到专用文件...”。

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

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

提示
您可以指定绝对路径或相对于http-client.private.env.json文件的路径。如果环境文件存储在scratch中，您还可以指定相对于项目根目录的路径。开始输入路径以获取代码完成弹出窗口。

或者，您可以将clientCertificate和描述clientCertificateKey为对象，这样您就可以指定除路径之外的证书格式。例如：

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

设置证书密码

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

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

单击装订线，或者将插入符号置于处hasCertificatePassphrase，然后按并选择“设置‘证书密码’的值”。AltEnter
在打开的窗口中，输入您的证书密码。

禁用证书验证

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

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

专业的HTTP客户端﻿

创建HTTP请求文件﻿

创建 HTTP 请求临时文件﻿

创建物理HTTP请求文件﻿

移动 HTTP 请求﻿

编写 HTTP 请求﻿

提示

笔记

从 HTTP 请求集合中打开请求﻿

笔记

转换 cURL 请求﻿

将 cURL 转换为 HTTP 请求﻿

将 HTTP 请求转换为 cURL﻿

导入 Postman 集合和环境﻿

将 Postman 集合导入到 HTTP 客户端﻿

使用上下文操作生成请求﻿

使用响应处理程序和预请求脚本﻿

插入响应处理程序脚本﻿

插入预请求脚本﻿

导入 JavaScript 代码﻿

笔记

为响应处理程序和预请求脚本启用 JavaScript 编码帮助﻿

执行HTTP请求﻿

在浏览器中打开请求﻿

使用 HTTP 请求运行/调试配置﻿

修改 HTTP 请求运行/调试配置﻿

保存临时 HTTP 请求运行/调试配置﻿

使用运行/调试配置执行请求﻿

查看来自 Web 服务的响应﻿

查看收到的回复﻿

在编辑器中打开响应文件﻿

比较临时文件中的响应﻿

比较请求历史记录中的响应﻿

查看请求历史记录﻿

笔记

打开请求历史记录﻿

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

管理cookies﻿

笔记

WebSocket 请求﻿

笔记

发送多条消息﻿

服务器响应后发送消息﻿

交互发送消息﻿

GraphQL﻿

提示

使用 GraphQL 查询编写 HTTP 请求﻿

使用 GraphQL 变量﻿

笔记

配置代理设置﻿

设置客户端 SSL/TLS 证书﻿

指定证书路径﻿

提示

设置证书密码﻿

禁用证书验证﻿

专业的
HTTP客户端

创建HTTP请求文件

创建 HTTP 请求临时文件

创建物理HTTP请求文件

移动 HTTP 请求

编写 HTTP 请求

从 HTTP 请求集合中打开请求

转换 cURL 请求

将 cURL 转换为 HTTP 请求

将 HTTP 请求转换为 cURL

导入 Postman 集合和环境

将 Postman 集合导入到 HTTP 客户端

使用上下文操作生成请求

使用响应处理程序和预请求脚本

插入响应处理程序脚本

插入预请求脚本

导入 JavaScript 代码

为响应处理程序和预请求脚本启用 JavaScript 编码帮助

执行HTTP请求

在浏览器中打开请求

使用 HTTP 请求运行/调试配置

修改 HTTP 请求运行/调试配置

保存临时 HTTP 请求运行/调试配置

使用运行/调试配置执行请求

查看来自 Web 服务的响应

查看收到的回复

在编辑器中打开响应文件

比较临时文件中的响应

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