llms.txt: machine-readable documentation index. Markdown version of this page is also available.

CLion 2026.3 Help

探索 HTTP 请求语法

本节介绍 HTTP 请求格式。 有关发送 HTTP 请求和查看 HTTP 响应的详细信息,请参阅 HTTP 客户端。

要在 CLion 代码编辑器中编写 HTTP 请求,请使用以下通用语法:

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

在 HTTP 请求中使用注释

  • 在请求中,使用 // 或 # 开始任何一行将其变成注释行。

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

为 HTTP 请求设置名称

为了在 运行/调试配置、 Search Everywhere和 运行一切中快速找到您的请求,您可以给它命名。

  • 在请求上方的 ###、 # @name 或 # @name = 旁边输入名称。

    输入 HTTP 请求名称

如果请求没有名称,CLion 将使用其在请求文件中的位置(例如 #1 )作为请求名称。 如果请求文件中包含多个同名请求,CLion 会将请求位置编号附加到每个名称后面。 这将使每个请求名称唯一,以便您可以在 服务 工具窗口、运行/调试配置等中轻松找到所需的请求。

服务工具窗口中的 HTTP 请求

使用简短格式进行 GET 请求

  • 对于 GET请求,您可以省略请求方法并且只指定 URI。

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

在单个文件中编写多个请求

  1. 通过在下方键入 ### 分隔符来标记请求的结束。

    // A basic request https://example.com/a/ ###
  2. 在分隔符下再写一个请求。

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

设置执行延迟

  • sleep(ms) 函数允许您暂停 HTTP 请求或脚本的执行,持续指定的毫秒数。 这对于各种连接测试、WebSocket 测试等非常有用。

    将 sleep() 函数与 await 关键字一起使用以暂停执行: await sleep(milliseconds)。

  • 如果您想在不阻塞脚本其余部分的情况下调度一段代码在延迟后运行,请使用 Web API 方法:

    • setTimeout() :调度一个函数在指定的毫秒数后运行一次。 返回一个计时器 ID。

    • clearTimeout() :取消通过 setTimeout() 设置的超时。 接受一个计时器 ID。

  • 在预请求脚本中,您可以延迟实际发送 HTTP 请求。 在响应处理程序中,使用这些函数来延迟测试执行或收到响应后的逻辑。

    < {% const job = setTimeout(() => { console.log("This timer is cleared and will not execute."); }, 1000); console.log("Pre-request: Starting sleep..."); clearTimeout(job); const start = Date.now(); await sleep(10000); console.log(`Pre-request: Finished sleep after ${Date.now() - start}ms`); console.log("Pre-request: Proceeding to request."); %} GET https://examples.http-client.intellij.net/anything > {% setTimeout(() => { console.log("Post-script: One second timer fired during sleep."); }, 1000); console.log("Post-script: Starting sleep..."); const start = Date.now(); await sleep(10000); console.log(`Post-script: Finished sleep after ${Date.now() - start}ms`); console.log("Post-script: Script execution complete."); %}

将长请求分成几行

  • 将所有查询字符串行缩进,但第一行除外。

    // Using line breaks with indent GET http://example.com:8080 /api /html /get ?id=123 &value=content
  • 如果因查询字符串导致 URL 过长,您可以使用专用的上下文操作将每个查询参数放在新行上。 将文本光标放到查询字符串部分,按 Alt+Enter (显示上下文操作 ),然后选择 将查询参数放在单独的行上。

    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
  • 同样,您可以在请求中格式化正文 Content-Type: application/x-www-form-urlencoded。 请将文本光标放置在正文处,按 Alt+Enter (显示上下文操作 ),然后选择 将表单-urlencoded 参数放在单独的行上。

    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 请求 | Space。

访问具有身份验证的 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 头字段值设置为 CLion 支持的 语言 之一,则相应的语言片段将被 自动注入 到 HTTP 请求消息体中。 如果未指定 内容类型 ,您可以手动插入语言片段。

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

    // 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 内容类型

  • 将请求的 内容类型设置为 multipart/form-data。 要作为 multipart/form-data 消息的一部分发送文件,请在 Content-Disposition 标头中包含 filename 参数。

    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--

禁用后续重定向

当 HTTP 请求被重定向(收到 3xx 状态码)时,将返回重定向页面的响应。 在 服务 工具窗口中,您可以查看重定向的页面响应以及请求过程中发生的所有重定向。

您可能希望禁用跟随重定向。 在这种情况下,将返回实际的重定向响应头(如 301 或 302)。

  • 在请求之前,添加一行带有 @no-redirect 标签的注释行。

    // @no-redirect example.com/status/301

如果您已经有一个重定向的请求,您可以点击 禁用 旁边的 Redirections 列表,位于 服务 工具窗口中。 这将向初始请求中添加 @no-redirect 标记。

HTTP 响应带有重定向

禁用将请求保存到请求历史

如有必要,您可以防止请求被保存到 请求历史记录。 这在请求包含一些敏感数据时会有所帮助,而您不希望记录这些数据。

  • 在请求之前,添加一行带有 @no-log 标签的注释行。

    // @no-log GET example.com/api

禁用将接收到的 cookie 保存到 cookies jar

如有必要,您可以防止接收的 cookie 保存到 cookies jar。 这样您就可以避免手动从 http-client.cookies 文件中删除不需要的 cookies。

  • 在请求之前,添加一行带有 @no-cookie-jar 标签的注释行。

    // @no-cookie-jar GET example.com/api

禁用编码

默认情况下,HTTP 客户端将请求参数和消息体编码为 ASCII 格式。 例如,请求参数中的斜杠字符将作为 %2F 发送。 您可以禁用编码以按原样发送请求。

  • 在请求之前,添加一行带有 @no-auto-encoding 标签的注释行。

    使用标签时,请求参数和消息体不会被编码:

    # @no-auto-encoding GET https://examples.com/api? name=@#$somebody& qwerty=%40%23%24

    生成的请求将按原样发送:

    https://examples.com/api?name=@#$somebody&qwerty=%40%23%24

    默认情况下,当未使用标签时,编码是启用的。

    ### Default behavior GET https://examples.com/api? name=@#$somebody& qwerty=%40%23%24

    在此请求中,参数将被编码:

    https://examples.com/api?name=%40%23%24somebody&qwerty=%40%23%24

自定义 HTTP 请求超时

HTTP 客户端 在与服务器建立连接时有 60 秒的超时,同时在持续连接中等待新数据包也有 60 秒的超时。 您可以自定义这两个超时。

  • 要为已建立的连接中的新数据包设置超时时间,请在请求前添加带有 @timeout 标签的注释行。

    # @timeout 600 GET example.com/api
  • 要设置连接超时,请在请求前添加带有 @connection-timeout 标签的注释行。

    // @connection-timeout 2 m GET example.com/api

默认情况下,超时值以秒为单位,但您可以在值后添加明确的时间单位: ms 为毫秒, s 为秒, m 为分钟,例如 100&#xa0;ms 或 5 m。

处理响应

您可以使用 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 Response 处理 API 参考。

重定向响应

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

  • {{$projectRoot}} 指向项目根目录

  • {{$historyFolder}} 指向 .idea/httpRequests/

以下示例 HTTP 请求在 HTTP 请求 文件旁边在 myFolder 中创建 myFile.json ,并将响应重定向到它。 如果文件已经存在,它会创建 myFile-1.json 。

POST https://httpbin.org/post Content-Type: application/json { "id": 999, "value": "content" } >> myFolder/myFile.json

以下示例 HTTP 请求在 myFile.json 中创建 .idea/httpRequests/ 。 如果文件已存在,它会覆盖文件。 它也会用位于项目根目录的 handler.js 脚本 处理响应。

POST https://httpbin.org/post Content-Type: application/json { "id": 999, "value": "content" } > {{$projectRoot}}/handler.js >>! {{$historyFolder}}/myFile.json
2026年 11月 6日