HTTP 客户端参考
client 对象可访问 HTTP 客户端会话元数据,并允许您 测试 HTTP 响应及在输出中 日志 文本。 每次 GoLand 启动时,该对象都会重新初始化,不会在 GoLand 重启之间保留数据。
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 | String | 要保存到全局存储中的变量名称。 |
varValue | String | 要保存到全局存储中的变量值。 |
get
返回 varName 变量的值。
参数 | 类型 | 描述 |
|---|---|---|
varName | String | 要返回的变量名称。 |
isEmpty
检查 global 对象是否未定义变量。
clear
从变量存储中移除 varName 变量。
参数 | 类型 | 描述 |
|---|---|---|
varName | String | 要移除的变量名称。 |
clearAll
从变量存储中移除所有变量。
headers.set
使用 client.global.headers.set(headerName, headerValue) 添加带有 headerValue 的 headerName 标头。 例如:
在响应处理器脚本中使用时,该标头将应用于所有后续 HTTP 请求。 在前置请求脚本中使用时,该标头将应用于当前的 HTTP 请求及所有后续请求。
参数 | 类型 | 描述 |
|---|---|---|
headerName | String | 要在 HTTP 请求中使用的标头名称。 |
headerValue | String | 标头值。 |
如需移除标头,请使用 null 作为值: