HTTP Client reference
The client object holds the HTTP Client session metadata (such as the list of global variables) and lets you test the HTTP response and log text in the output. The HTTP Client session is started when PhpStorm starts, and ends when PhpStorm is closed. Values are not preserved between PhpStorm restarts.
The client object provides access to the global nested object that serves as a variable storage.
Creates a test with the name testName and body func. All tests are executed after the response handler script. Test results are displayed in the Tests tab of the Services tool window.
Parameter | Type | Description |
|---|---|---|
testName | String | Test name |
func | function | JavaScript function to test an HTTP response |
Checks that the specified condition is true; throws an exception otherwise. The optional message parameter serves as an exception message.
Parameter | Type | Description |
|---|---|---|
condition | boolean | The condition to check in the response |
message | String | The optional message to return in case the condition evaluates to false. |
Prints text to the output of the response handler or pre-request script and then terminates the line.
Parameter | Type | Description |
|---|---|---|
text | String | Text to be printed in the output of the response handler or pre-request script. |
Terminates execution of the response handler script.
The global variables storage, which is used for setting and removing global variables and headers.
Once you assign a value to a global variable (client.global.set(VariableName, VariableValue)), you can access it as {{VariableName}} in subsequent HTTP requests or using client.global.get("VariableName") in response handler scripts and pre-request scripts. See Use global variables for a more detailed example.
The global object allow you to do the following:
Set and get global variables. These variables are global because, once set, they can be accessed from any HTTP request.
Set global headers. Once set, they apply to all HTTP requests.
Saves the variable with the varName name to the storage and sets its value to varValue. See Use global variables for a more detailed example.
Parameter | Type | Description |
|---|---|---|
varName | String | The name of the variable to be saved to the global storage. |
varValue | String | The variable value to be saved to the global storage. |
Returns the value of the varName variable.
Parameter | Type | Description |
|---|---|---|
varName | String | The name of the variable to be returned. |
Checks whether the global object has no variables defined.
Removes the varName variable from the variables storage.
Parameter | Type | Description |
|---|---|---|
varName | String | The name of the variable to be removed. |
Removes all variables from the variables storage.
Use client.global.headers.set(headerName, headerValue) to add the headerName header with the headerValue. For example:
client.global.headers.set("X-Our-Header-1", "value1")When used in response handler scripts, the header is applied to all subsequent HTTP requests. When used in pre-request scripts, the header is applied to the current HTTP request and to all subsequent requests.
Parameter | Type | Description |
|---|---|---|
headerName | String | The name of the header to be used in HTTP requests. |
headerValue | String | The header value. |
To remove the header, use null as the value:
client.global.headers.clear(headerName, null))Thanks for your feedback!