WebStorm 2025.2 Help

HTTP 请求和响应参考

响应属性

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

属性

描述

body （string | TextStreamResponse | object）

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

headers （ResponseHeaders）

响应 headers 存储对象。

status （int）

响应状态，例如 200 或 404。

contentType （ContentType）

contentType 对象 ，包含对 Content-Type 响应 header 值的数据。

Headers 对象

ResponseHeaders 对象用于检索响应 header 的值数据。

方法

方法

参数

描述

valueOf

headerName （string）

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

valuesOf

headerName （string）

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

ContentType 对象

ContentType 数据对象包含从 Content-Type 响应 header 获取的信息。

属性

属性

描述

mimeType （string）

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

charset （string）

响应字符集的字符串表示，例如 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() ：以原始格式返回请求体：如果请求体包含变量，仅显示变量名称而不是其值。 例如：

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

  • tryGetSubstituted() ：返回请求体，并用已知的值替换所有变量。

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

请求的 body ，以字符串形式表示。 例如：

client.log(request.body())

environment

包含 get(name) 方法，用于获取由其 name 标识的 环境变量 的值，如果不存在则返回 null。

headers

包含两个方法：

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

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

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

  • name ：header 的名称，例如 Content-Type。

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

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

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

  • name ：header 的名称，例如 Content-Type。

  • value() ：header 的值，例如 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年 9月 26日
HTTP Client 支持的 JavaScript API响应处理示例