PyCharm 2025.3 Help

HTTP 请求与响应参考

响应属性

response 对象包含关于已接收的 HTTP Response 的信息（响应内容、标头、状态等），并提供对嵌套的 headers 和 contentType 对象的访问。

属性

说明

body （字符串 | TextStreamResponse | 对象）

响应内容，可以是一个字符串、一个 TextStreamResponse 对象或一个 JSON 对象。

headers （ResponseHeaders）

响应标头存储对象。

status （整数）

响应状态，例如 200 或 404。

contentType （ContentType）

contentType 对象 ，其中包含 Content-Type 响应标头值的数据。

Headers 对象

ResponseHeaders 对象用于检索响应标头的值。

方法

方法

参数

说明

valueOf

headerName （字符串）

检索 headerName 响应标头的第一个值；如果 headerName 响应标头不存在，则返回 null。

valuesOf

headerName （字符串）

检索包含 headerName 响应标头的所有值的数组。 如果 headerName 响应标头不存在，则返回空数组。

ContentType 对象

ContentType 数据对象包含来自 Content-Type 响应标头的信息。

属性

属性

说明

mimeType （字符串）

响应的 MIME 类型，例如 text/plain、 text/xml、 application/json。

charset （字符串）

响应字符集的字符串表示形式，例如 utf-8。

TextStreamResponse 对象

TextStreamResponse 接口用于将响应作为文本流进行处理。 它允许您实现两个方法：

  • onEachLine(subscriber, onFinish) ，用于遍历流中的每一行。

  • onEachMessage(subscriber, onFinish) ，用于订阅服务器发送的每条消息。 这可用于 WebSocket、GRPC 以及基于 WebSocket 的 GraphQL。

参数

参数

在 onEachLine 中的用法

在 onEachMessage 中的用法

subscriber

用于处理流中各行的函数。 它接受两个参数：

  • line ：作为流的一部分接收到的字符串或 JSON 对象。

  • unsubscribe ：一个函数，用于终止当前 onEachLine 块的执行。 它可以用于在满足某个条件时停止流处理。

用于处理流消息的函数。 它接受三个参数：

  • message ：作为流的一部分接收到的字符串或 JSON 对象。

  • unsubscribe ：一个函数，用于终止当前 onEachMessage 块的执行。 它可以用于在满足某个条件时停止流处理。

  • output （可选）：一个函数，接收一个字符串（消息）并将其参数发送回服务器。

onFinish

在流结束后要执行的函数。

有关其用法的示例，请参阅 响应处理示例 ，或在 .http 文件中点击 示例 并选择 WebSocket 请求 或 GraphQL 请求。

请求属性

request 对象包含关于 HTTP 请求的信息，并可同时用于预请求脚本和响应处理程序脚本。

属性

在预请求脚本中使用时

在响应处理程序脚本中使用时

body()

请求 body 使用以下两种方法之一获取：

  • getRaw() ：以原始格式返回请求 body：如果 body 包含变量，则显示其名称而不是其值。 例如：

    client.log(request.body.getRaw());

  • tryGetSubstituted() ：返回将所有已知变量替换为其值后的请求 body。

    client.log(request.body.tryGetSubstituted());

请求 body 作为字符串。 例如：

client.log(request.body())

environment

具有 get(name) 方法，该方法根据其 name 标识检索 环境变量 的值；如果不存在，则返回 null。

headers

具有两个方法：

  • all ：返回包含当前请求所有标头值的数组。

  • findByName(name) ：检索由 name 参数标识的标头的值。

数组中的每个元素都是一个请求标头，具有以下方法：

  • name ：标头名称，例如 Content-Type。

  • getRawValue ：以原始格式返回标头值：如果标头包含变量，则显示其名称而不是其值。

  • tryGetSubstitutedValue() ：返回将所有已知变量替换为其值后的标头。

数组中的每个元素都是一个请求标头，具有以下方法：

  • name ：标头名称，例如 Content-Type。

  • value() ：标头值，例如 application/json。

method

请求中使用的 HTTP 方法（例如 GET 或 POST）。 例如： client.log(request.method)

url()

请求 URL 使用以下两种方法之一获取：

  • getRaw() ：以原始格式返回请求 URL：如果 URL 包含变量，则显示其名称而不是其值。 例如：

    client.log(request.url.getRaw());

  • tryGetSubstituted() ：返回将所有已知变量替换为其值后的请求 URL。

    client.log(request.url.tryGetSubstituted());

请求 URL 作为字符串。 例如：

client.log(request.url())

variables

具有 get(name) 方法，该方法根据其 name 标识检索 请求级变量 的值；如果不存在，则返回 null。

iteration()

获取当前迭代的编号（索引）

对于表示集合的变量。

templateValue(Integer)

按其在循环中的索引获取集合元素的值。

最后修改日期： 2025年 12月 2日
HTTP 客户端支持的 JavaScript API响应处理示例