PyCharm 2025.3 Help

HTTP 客户端参考

client 对象提供对 HTTP 客户端会话元数据的访问,并允许您在输出中 测试 HTTP 响应和 日志 文本。 每次 PyCharm 启动时,该对象都会重新初始化,不会在 PyCharm 重启之间保留数据。

client 对象还公开了充当变量存储的嵌套 global 对象。

方法

test

创建一个名称为 testName 、主体为 func 的测试。 所有测试都会在响应处理程序脚本之后执行。 测试结果显示在 测试 选项卡,位于 服务 工具窗口中。

参数

类型

描述

testName

String

测试名称

func

function

用于测试 HTTP 响应的 JavaScript 函数

assert

检查指定的 condition 是否为 true ;否则抛出异常。 可选的 message 参数用作异常消息。

参数

类型

描述

condition

boolean

要在响应中检查的条件

message

String

当条件求值为 false 时要返回的可选消息。

log

text 打印到响应处理程序脚本或预请求脚本的输出中,然后终止该行。

参数

类型

描述

text

String

要在响应处理程序脚本或预请求脚本的输出中打印的文本。

exit

终止响应处理程序脚本的执行。

属性

global

全局变量存储 ,用于设置和移除全局变量和标头。

一旦您为全局变量(client.global.set(VariableName, VariableValue) )赋值,您可以在后续的 HTTP 请求中以 {{VariableName}} 的形式访问它,或者在响应处理程序脚本和预请求脚本中使用 client.global.get("VariableName")。 请参阅 使用全局变量 以获取更详细的示例。

全局变量和标头

global 对象允许您执行以下操作:

  • 设置并获取全局变量。

  • 设置全局标头。

    全局标头可帮助您避免在多个 HTTP 请求中重复初始化相同的标头。 设置后,它们会隐式应用于同一执行流程中的所有后续请求。

    全局标头并非用于存储持久状态。 它们仅限于单个执行流程,旨在简化标头复用。

set

将名称为 varName 的变量保存到存储中,并将其值设置为 varValue。 请参阅 使用全局变量 以获取更详细的示例。

参数

按类型分组

描述

varName

字符串

要保存到全局存储的变量名称。

varValue

字符串

要保存到全局存储的变量值。

get

返回 varName 变量的值。

参数

按类型分组

描述

varName

字符串

要返回的变量名称。

isEmpty

检查 global 对象是否未定义变量。

clear

varName 变量从变量存储中移除。

参数

按类型分组

描述

varName

字符串

要删除的变量名称。

clearAll

从变量存储中移除所有变量。

headers.set

使用 client.global.headers.set(headerName, headerValue) 添加带有 headerNameheaderValue 的头信息。 例如:

client.global.headers.set("X-Our-Header-1", "value1")

在响应处理脚本中使用时,该头信息会应用于所有后续的 HTTP 请求。 在预请求脚本中使用时,该头信息会应用于当前的 HTTP 请求以及所有后续请求。

参数

按类型分组

描述

headerName

字符串

要在 HTTP 请求中使用的头信息名称。

headerValue

字符串

头信息的值。

要移除头信息,请将 null 用作值:

client.global.headers.clear(headerName, null))
最后修改日期: 2025年 12月 2日