专业的
探索 HTTP 请求语法

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

Request-Body

将多个请求写入一个文件中

###通过在请求下方键入分隔符来标记请求的结束。
```
// A basic request
http://example.com/a/

###
```

在分隔符下方撰写另一个请求。

// A basic request
http://example.com/a/

###

// A second request using the GET method
http://example.com:8080/api/html/get?id=123&value=content

将长请求分成几行

缩进除第一行之外的所有查询字符串行。
```
// Using line breaks with indent
GET http://example.com:8080
    /api
    /html
    /get
    ?id=123
    &value=content
```
提示
URL 部分的缩进大小在“设置”|“设置”中配置。编辑| 代码风格| HTTP 请求 | 制表符和缩进| URL 部分缩进。
如果 URL 由于查询字符串而太长，您可以使用专用上下文操作将每个查询参数放在新行中。将插入符号放在查询字符串部分，按（显示上下文操作），然后选择将查询参数放在单独的行上。AltEnter
前
GET https://example.com:8080/api/get/html?firstname=John&lastname=Doe&planet=Tatooine&town=Freetown
后
GET https://example.com:8080/api/get/html? firstname=John& lastname=Doe& planet=Tatooine& town=Freetown
笔记
您可以使用设置 |中的 HTTP 客户端代码样式强制查询参数的一致包装。编辑| 代码风格| HTTP 请求 | 包裹和支架| 查询参数换行。
同样，您可以使用来格式化请求中的正文Content-Type: application/x-www-form-urlencoded。将插入符号放在正文处，按（显示上下文操作），然后选择将表单 urlencoded 参数放在单独的行上。AltEnter
前
POST https://ijhttp-examples.jetbrains.com/post Content-Type: application/x-www-form-urlencoded key1=value1&key2=value2&key3=value3&key4=value4&key5=value5
后
POST https://ijhttp-examples.jetbrains.com/post Content-Type: application/x-www-form-urlencoded key1 = value1 & key2 = value2 & key3 = value3 & key4 = value4 & key5 = value5
要配置正文的环绕x-www-form-urlencoded，请使用设置| 编辑| 代码风格| HTTP 请求 | 包裹和支架| 表单 urlencoded 参数换行。要配置前后和=之前的空格&，请使用设置| 编辑| 代码风格| HTTP 请求 | 空格。

通过身份验证访问 Web 服务

根据您正在访问的 Web 服务，提供基本或摘要授权标头。

// Basic authentication
GET http://example.com
Authorization: Basic username password

###

// Digest authentication
GET http://example.com
Authorization: Digest username password

提供请求消息体

在适当的位置键入请求正文：
```
// The request body is provided in place
POST https://example.com:8080/api/html/post HTTP/1.1
Content-Type: application/json
Cookie: key=first-value

{ "key" : "value", "list": [1, 2, 3] }
```
如果将Content-Type标头字段值设置为PyCharm 支持的语言之一，则相应的语言片段将自动注入到 HTTP 请求消息正文中。如果未指定Content-Type，您可以手动注入语言片段。

要从文件中读取请求正文，请键入符号<，后跟文件路径。

// The request body is read from a file
POST https://example.com:8080/api/html/post
Content-Type: application/json

< ./input.json

使用 multipart/form-data 内容类型

将请求的Content-Type设置为multipart/form-data。要将文件作为multipart/form-data消息的一部分发送，请filename在Content-Disposition标头中包含该参数。

POST https://example.com/api/upload HTTP/1.1
Content-Type: multipart/form-data; boundary=boundary

--boundary
Content-Disposition: form-data; name="first"; filename="input.txt"

// The 'input.txt' file will be uploaded
< ./input.txt

--boundary
Content-Disposition: form-data; name="second"; filename="input-second.txt"

// A temporary 'input-second.txt' file with the 'Text' content will be created and uploaded
Text
--boundary
Content-Disposition: form-data; name="third";

// The 'input.txt' file contents will be sent as plain text.
< ./input.txt --boundary--

提示
要加快创建多部分/表单数据请求的速度，请使用mptr live template。

禁用以下重定向

如果您已有重定向请求，则可以单击“服务”工具窗口中列表旁边的“禁用”。这会将标签添加到初始请求中。Redirections@no-redirect

禁止将请求保存到请求历史记录

禁止将收到的 cookie 保存到 cookie jar

使用变量

变量的名称可以包含字母、数字、下划线符号_、连字符-或点符号.。

环境变量

环境变量允许您在项目中存储一组环境定义。例如，您可以{{host}}在不同的环境中创建变量，而不是在请求中显式提供主机名：开发环境中的本地主机名和生产环境中的公共主机名。然后，您可以使用当前.http文件编辑器顶部的运行方式列表来选择环境：

定义环境变量

在请求编辑器面板顶部的运行方式列表中，选择要添加环境的位置：
- 如果您希望环境公开，请选择将环境添加到公共文件...。这会将环境添加到http-client.env.json文件中。该文件可以包含常见变量，例如主机名、端口或查询参数，并且应与您的项目一起分发。
- 如果您希望环境是私有的，请选择将环境添加到私有文件...。这会将环境添加到http-client.private.env.json文件中。该文件可能包含密码、令牌、证书和其他敏感信息。http-client.private.env.json文件中指定的变量值将覆盖公共环境文件中的值。
提示
如有必要，您可以手动创建这些文件。

使用所需的变量填充创建的文件。

以下示例http-client.env.json环境文件定义了两个环境：开发和生产。附加的http-client.private.env.json文件保存敏感授权数据。

http-client.env.json

http-client.private.env.json

{
    "development": {
        "host": "localhost",
        "id-value": 12345,
        "username": "",
        "password": "",
        "my-var": "my-dev-value"
    },

    "production": {
        "host": "example.com",
        "id-value": 6789,
        "username": "",
        "password": "",
        "my-var": "my-prod-value"
    }
}

HTTP请求示例如下：

GET http://{{host}}/api/json/get?id={{id-value}}
Authorization: Basic {{username}} {{password}}
Content-Type: application/json

{
    "key": "{{my-var}}"
}

在执行请求之前，PyCharm 允许您使用请求编辑器面板顶部的运行方式列表选择执行环境。

根据您的选择，生成的请求将是以下之一：

发展

生产

GET http://localhost/api/json/get?id=12345
Authorization: Basic dev-user dev-password
Content-Type: application/json

{
    "key": "my-dev-value"
}

管理多个环境文件

root/http-client.env.json # public file with 'dev' environment and 'host' variable
root/service1/http-client.private.env.json # private file with 'dev' environment and "key": "myKey1" variable
root/service2/http-client.private.env.json # private file with 'dev' environment and "key": "myKey2" variable

当您选择环境时，.http存储在目录中的文件将service1使用变量myKey1的值。存储在目录中的文件将使用该变量的值。keydev.httpservice2myKey2key

如果私有文件包含host变量，则.http文件将使用其值，因为私有文件优先于公共文件。否则，他们将使用公共文件中的值。

就地变量

要创建就地变量，请@在 HTTP 方法部分上方键入后跟变量名称。例如：

@myhost = example.org

GET {{myhost}}/users

###
GET {{myhost}}/stats

每个请求变量

您可以使用该request.variables.set(variableName, variableValue)方法设置 HTTP 请求中使用的变量的值。将其写入封装在 HTTP 请求上方的预请求脚本中{% ... %}。例如：

< {%
    request.variables.set("firstname", "John")
%}
GET http://example.org/{{firstname}}

< {%
    const signature = crypto.hmac.sha256()
        .withTextSecret(request.environment.get("secret")) // get variable from http-client.private.env.json
        .updateWithText(request.body.tryGetSubstituted())
        .digest().toHex();
    request.variables.set("signature", signature)

    const hash = crypto.sha256()
        .updateWithText(request.body.tryGetSubstituted())
        .digest().toHex();
    request.variables.set("hash", hash)
%}
POST https://httpbin.org/post
X-My-Signature: {{signature}}
X-My-Hash: {{hash}}
Content-Type: application/json

动态变量

每次运行请求时，动态变量都会生成一个值。他们的名字开头是$：

GET http://localhost/api/get?id={{$uuid}}

处理响应

您可以使用 JavaScript 处理响应。>在请求后键入字符并指定 JavaScript 文件的路径和名称，或者将响应处理程序脚本代码封装在{% ... %}.

GET https://httpbin.org/get

> /path/to/responseHandler.js

GET https://httpbin.org/get

> {%
    client.global.set("my_cookie", response.headers.valuesOf("Set-Cookie")[0]);
%}

重定向响应

您可以将响应重定向到文件。如果文件已存在，则用于>>创建带有后缀的新文件；>>!如果文件存在，则用于重写该文件。您可以指定绝对路径或相对于当前 HTTP 请求文件的路径。您还可以在路径中使用变量，包括环境变量和以下预定义变量：

POST https://httpbin.org/post
Content-Type: application/json

{
  "id": 999,
  "value": "content"
}

>> myFolder/myFile.json

POST https://httpbin.org/post
Content-Type: application/json

{
  "id": 999,
  "value": "content"
}

> {{$projectRoot}}/handler.js

>>! {{$historyFolder}}/myFile.json

感谢您的反馈意见！

此页面是否有帮助？

专业的探索 HTTP 请求语法﻿

在 HTTP 请求中使用注释﻿

设置 HTTP 请求的名称﻿

使用简短形式进行 GET 请求﻿

将多个请求写入一个文件中﻿

将长请求分成几行﻿

提示

前

后

笔记

前

后

通过身份验证访问 Web 服务﻿

笔记

提供请求消息体﻿

使用 multipart/form-data 内容类型﻿

提示

禁用以下重定向﻿

禁止将请求保存到请求历史记录﻿

禁止将收到的 cookie 保存到 cookie jar﻿

使用变量﻿

在请求中使用变量﻿

环境变量﻿

定义环境变量﻿

提示

笔记

管理多个环境文件﻿

就地变量﻿

每个请求变量﻿

动态变量﻿

处理响应﻿

重定向响应﻿

笔记