HTTP 客户端参考
client 对象提供对 HTTP Client 会话元数据的访问,并允许您在输出中 测试 HTTP 响应和 日志 文本。 每次 PhpStorm 启动时,该对象都会重新初始化,不会在 PhpStorm 重启之间保留数据。
client 对象还公开了嵌套的 global 对象,用作变量存储。
方法
test
创建一个名称为 testName 且内容为 func 的测试。 所有测试在响应处理程序脚本之后执行。 测试结果显示在 测试 选项卡的 服务 工具窗口。
参数 | Type | 描述 |
|---|---|---|
testName | String | 测试名称 |
func | function | JavaScript 函数用于测试 HTTP 响应 |
断言
检查指定的 condition 是否为 true ;否则抛出异常。 可选的 message 参数充当异常消息。
参数 | Type | 描述 |
|---|---|---|
condition | boolean | 检查响应中的条件 |
message | String | 如果条件评估为假,则返回的可选消息。 |
日志
将 text 输出到响应处理程序或预请求脚本的输出中,然后终止该行。
参数 | Type | 描述 |
|---|---|---|
text | String | 在响应处理程序或预请求脚本的输出中打印的文本。 |
退出
终止响应处理程序脚本的执行。
属性
global
用于设置和移除全局变量和头信息的 全局变量存储。
一旦您为全局变量 (client.global.set(VariableName, VariableValue)) 分配了一个值,您可以在随后的 HTTP 请求中以 {{VariableName}} 访问它,或在响应处理程序脚本和预请求脚本中使用 client.global.get("VariableName") 访问它。 请参阅 使用全局变量 以获取更详细的示例。
全局变量和头信息
global 对象允许您执行以下操作:
设置和获取全局变量。
设置全局头信息。
全局头可以帮助您避免在多个 HTTP 请求中重复初始化相同的头。 一旦设置,它们会隐式应用于同一执行流程中的所有后续请求。
全局头并非用于存储持久状态。 它们仅限于单个执行流程,旨在简化头的重用。
set
将变量与 varName 名称一起保存到存储中,并将其值设置为 varValue。 请参阅 使用全局变量 以获取更详细的示例。
参数 | Type | 描述 |
|---|---|---|
varName | String | 要保存到全局存储的变量名称。 |
varValue | String | 要保存到全局存储的变量值。 |
get
返回 varName 变量的值。
参数 | Type | 描述 |
|---|---|---|
varName | String | 要返回的变量名称。 |
isEmpty
检查 global 对象是否未定义变量。
清除
将 varName 变量从变量存储中移除。
参数 | Type | 描述 |
|---|---|---|
varName | String | 要删除的变量名称。 |
清除所有
从变量存储中移除所有变量。
headers.set
使用 client.global.headers.set(headerName, headerValue) 添加 headerName 头信息及其 headerValue。 例如:
在响应处理脚本中使用时,该头信息将应用于所有后续的 HTTP 请求。 在预请求脚本中使用时,该头信息将应用于当前 HTTP 请求及所有后续请求。
参数 | Type | 描述 |
|---|---|---|
headerName | String | 在 HTTP 请求中使用的头信息名称。 |
headerValue | String | 头信息的值。 |
要移除头信息,请使用 null 作为值: