PhpStorm 2022.2 Help

HTTP Client

With the HTTP Client plugin, you can create, edit, and execute HTTP requests directly in the PhpStorm code editor.

Example HTTP request

There are two main use cases when you need to compose and run HTTP requests:

  • When you are developing a RESTful web service and want to make sure it works as expected, is accessible in compliance with the specification, and responds correctly.

  • When you are developing an application that addresses a RESTful web service. In this case, it is helpful to investigate the access to the service and the required input data before you start the development. During the development, you may also call this web service from outside your application. This may help locate errors when your application results in unexpected output while no logical errors are detected in your code and you suspect that the bottleneck is the interaction with the web service.

HTTP requests are stored in .http and .rest files and are marked with the HTTP file icon icon.

Support for HTTP files includes the following features:

If necessary, before you begin, configure the Proxy settings on the HTTP Proxy page of the Settings/Preferences dialog (Ctrl+Alt+S).

Watch this video for a quick HTTP Client overview:

Create HTTP request files

You can work with HTTP requests either from scratch files or from physical files of the HTTP Request type. Each file can contain multiple requests, and you can create as many files as needed.

Scratch files can be used to test HTTP requests during development. Scratch files are not stored inside a project, so PhpStorm can modify them and add additional information about the request. When an HTTP request is executed from a scratch file, the link to the response output file is added below the request and at the top of the requests history file.

Create an HTTP request scratch file

  • Press Ctrl+Alt+Shift+Insert and select HTTP Request.

Physical files can be used for documenting, testing, and validating HTTP requests. Physical files are stored inside your project, and PhpStorm will not modify them. When an HTTP request is executed from a physical file, this file is not modified. Information about the executed request with the link to the response output file is added to the top of the requests history file.

Create a physical HTTP request file

  • In the File menu, point to New, and then click HTTP Request.

Move an HTTP request

You can use the Move refactoring F6 to move HTTP requests from scratches to physical files, as well as between physical files.

  1. In the editor, position the caret at the request to be moved and do one of the following:

    • From the main menu or the context menu, select Refactor | Move.

    • Press Alt+Enter and select the Move HTTP Requests intention action.

    • Press F6.

  2. In the Move HTTP Requests dialog that opens, do the following:

    1. In the Path field, choose one of the existing .http files from the list or click the Browse button to locate the file.

      You can also type the full path to the file manually. If you specify the name of a non-existing file, a new file with the provided name will be created automatically.

    2. In the Requests list, select the checkboxes next to the requests you want to move.

    Move HTTP requests

Compose HTTP requests

PhpStorm uses the HTTP request in Editor format, which provides a simple way to create, execute, and store information about HTTP requests. You can type them directly in the created HTTP request files using the following general syntax:

### Method Request-URI HTTP-Version Header-field: Header-value Request-Body

After the ### separator, you can enter any comments preceded by # or //.

To speed up composing HTTP requests, you can:

  • Click Tools | HTTP Client | Create Request in HTTP Client. If a request file is opened in the editor, this will add a request template to the opened file. Otherwise, this will create a new .http scratch file.

  • Click App general add on top of the request's editor panel. In the popup menu, choose the type of the request to add.

    Add an HTTP request

Alternatively, use live templates. In the editor, you can press Ctrl+J to view the list of available templates. For example, gtr expands to a simple GET request; mptr expands to a multipart/form-data POST request.

expand_post_template

To get an overview of the HTTP Client possibilities, you can explore the HTTP Requests Collection, which is a handful selection of composed requests.

Open a request from the HTTP Requests Collection

  1. Click the Examples shortcut link on top of the request's editor panel.

  2. In the popup menu, choose the HTTP Requests collection you wish to open:

    Open HTTP Requests Collection popup

Convert cURL requests

If you are working with cURL requests, you can convert between cURL requests and the HTTP request in Editor format.

Convert cURL to HTTP request

  • Paste the cURL request into an HTTP request file. PhpStorm will convert it to the HTTP request format and leave the original cURL request commented out for later reference.

    cURL request converted to HTTP request on paste
  • Alternatively, click Convert cURL to HTTP request on top of the HTTP request editor panel and select Convert cURL to HTTP Request.

    In the Convert cURL to HTTP Request dialog, type or paste the cURL request that you want to convert.

    the Convert cURL to HTTP Request dialog

Consider the following example cURL request:

curl 'http://httpbin.org/' -H 'Connection: keep-alive' -H 'Accept: text/html' -H 'Accept-Encoding: gzip, deflate' -H 'Accept-Language: en-US,en;q=0.9,es;q=0.8'

PhpStorm will convert it to the following:

# curl 'http://httpbin.org/' -H 'Connection: keep-alive' -H 'Accept: text/html' -H 'Accept-Encoding: gzip, deflate' -H 'Accept-Language: en-US,en;q=0.9,es;q=0.8' GET http://httpbin.org/ Connection: keep-alive Accept: text/html Accept-Encoding: gzip, deflate Accept-Language: en-US,en;q=0.9,es;q=0.8 ###

The converter supports the following cURL options:

Option

Description

-X, --request

The request method to use.

-H, --header

The request header to include in the request.

-u, --user

--basic

--digest

The user's credentials to be provided with the request, and the authorization method to use.

-d, --data, --data-ascii

--data-binary

--data-raw

--data-urlencode

The data to be sent in a POST request.

-F, --form

The multipart/form-data message to be sent in a POST request.

--url

The URL to fetch (mostly used when specifying URLs in a config file).

-i, --include

Defines whether the HTTP response headers are included in the output.

-v, --verbose

Enables the verbose operating mode.

-L, --location

Enables resending the request in case the requested page has moved to a different location.

Convert HTTP request to cURL

  1. Put the caret at the HTTP request that you want to convert to cURL format.

  2. Click Alt+Enter and select Convert to cURL and copy to clipboard.

    Alternatively, you can click the Convert shortcut link on top of the HTTP request editor panel and select Convert HTTP Request Under Caret to cURL and Copy.

This will generate a cURL request based on the HTTP request and copy it to the clipboard.

Create requests from OpenAPI specifications

When working with OpenAPI Specification files, you can create HTTP requests to the specified endpoints.

Create an HTTP request to an endpoint

  • In an OpenAPI specification file, click the Open in HTTP Client button in the editor gutter next to the endpoint definition.

PhpStorm will create a new HTTP request and save it in the generated-requests.http scratch file.

Creating an HTTP request to an endpoint

Rename an endpoint and its usages

Use the Rename refactoring to rename the defined endpoint and its usages in HTTP requests simultaneously.

  1. Do any of the following:

    • In an OpenAPI specification file, position the caret at the endpoint's definition you want to rename.

    • In an HTTP request file, position the caret at the URL path segment you want to rename.

  2. Select Refactor | Rename from the main menu or the context menu, or press Shift+F6.

  3. In the Rename dialog that opens, specify the new endpoint's name.

  4. Preview and apply changes.

PhpStorm will rename the endpoint and its usages.

Renaming an HTTP endpoint

Create and run Guzzle requests

If you use the Guzzle PHP HTTP client in your project, you can test HTTP requests in the editor without running the actual code.

If PhpStorm can infer a URL and HTTP method from code, the HTTP Request icon the HTTP request icon is displayed in the editor gutter.

  1. Click the HTTP request icon to create an HTTP scratch file and open it in the editor. The created file has the name of the original PHP file with the Guzzle request and contains prefilled request details such as basic authentication fields, request body, headers, and query parameters.

  2. In the HTTP scratch file, position the caret at the request you want to execute, press Alt+Enter and select Run <request name>. Alternatively, click The Run button in the editor gutter. See Execute HTTP requests for details.

Creating an HTTP request from Guzzle call

Use response handler scripts

With response handler scripts, you can programmatically react to a received HTTP response. By using these scripts, you can automatically process the received data as well as validate it against the conditions that you specify. Response handler scripts are provided as a part of the request within the HTTP request file and are executed as soon as a response is received. To view the response handling examples, open the Requests with Authorization or Requests with Tests requests collections.

You can insert a response handler script into your request either in-place or by referring to an external file.

Insert the script into the request

  • To insert the script in-place, prepend it with > and enclose it in {% %}:

    GET host/api/test > {% // Response Handler Script ... %}
  • To insert the script from an external file, prepend it with >:

    GET host/api/test > scripts/my-script.js

Response handler scripts are written in JavaScript ECMAScript 5.1, with coding assistance and documentation handled by the bundled HTTP Response Handler library. For in-place scripts, this functionality is enabled automatically. For external scripts, you need to enable it manually.

Enable JavaScript coding assistance for response handler scripts

  1. Open the script file in the editor.

  2. In the context menu, choose Use JavaScript Library | HTTP Response Handler.

The HTTP Response Handler library exposes two objects to be used for composing response handler scripts:

  • The client object stores the session metadata, which can be modified inside the script. The client state is preserved until you close PhpStorm. Every variable saved in client.global as variable_name is accessible to subsequent HTTP requests as {{variable_name}}.

  • response holds information about the received response: its content type, status, response body, and so on.

To open the HTTP Response Handler library in the editor, position the caret at the library object and press Ctrl+B.

Response handler scripts can include tests, which lets you use the HTTP Client as a testing framework. To create a test, invoke the client.test(testName, function) method. Inside the test, you can assert a condition by invoking the client.assert(condition, message) method, for example:

GET https://httpbin.org/status/200 > {% client.test("Request executed successfully", function() { client.assert(response.status === 200, "Response status is not 200"); }); %}

Execute HTTP requests

  1. If you are going to test your own web service, make sure it is deployed and running.

  2. If you have environments defined, select an environment in the Run with list on top of the request's editor panel.

  3. In the gutter, click The Run button next to the request.

If you have multiple HTTP requests defined in an .http file, you can run all of them sequentially. To do this, click Run all HTTP requests on top of the request's editor panel.

Debug HTTP requests

Besides debugging the entire application, you can debug separate HTTP Requests. This is helpful when you are actually interested in a specific page that is accessed in a number of steps, but for this or that reason you cannot specify this page as the start page for debugging, for example, because you need to "come" to this page with certain data.

  1. Make sure to perform the preparatory steps as described in Debug a PHP HTTP request:

  2. Position the caret at the request and press Alt+Enter or click The Run button in the editor gutter. From the popup menu, select PHP Debug <host>.

    PHP Debug intention action with  in an HTTP request file

    If you have environments defined, select PHP Debug with ... and choose the environment in the popup menu. The selected environment will be used as the default one when executing or debugging the request later.

    PHP Debug intention action with environment in an HTTP request file

    PhpStorm will automatically add the XDEBUG_SESSION cookie to the request, execute it, and stop at the specified breakpoint.

When a request is executed, PhpStorm automatically creates a dedicated temporary HTTP Request run/debug configuration for it. You can save it as a permanent run/debug configuration if necessary.

Open a request in the browser

You can open an HTTP request in the browser specified on the Web Browsers and Preview page of the Settings/Preferences dialog (Ctrl+Alt+S).

Work with HTTP request run/debug configurations

When you execute an HTTP request from the editor, PhpStorm automatically creates a temporary run/debug configuration with the request parameters. A temporary run/debug configuration works the same way as a permanent run/debug configuration. You can change its settings using the Run/Debug Configuration dialog and optionally save it as permanent.

Modify an HTTP Request run/debug configuration

  1. Do any of the following:

    • In the editor, right-click a request and in the context menu, select Modify Run Configuration.

    • Alternatively, choose Run | Edit Configurations from the main menu, and select the needed run/debug configuration in the HTTP Request list.

  2. Change the needed configuration parameters:

    • In the Environment list, select an environment that will define the set of environment variables used in the request.

    • In the File field, provide the path to the HTTP request file. You can type the path manually and use path completion Ctrl+Space as you type, or click Open from disk and select the required folder in the dialog that opens.

    • If your request file contains multiple requests, in the Request list, choose the name of the request to execute.

Save a temporary HTTP Request run/debug configuration

  • In the Run/Debug Configuration selector, choose Save <configuration name>.

  • In the Run/Debug Configuration dialog, select the configuration and click the Save button.

Execute a request using a run/debug configuration

  • In the Run/Debug Configuration selector, select the desired run configuration. Then click Run button on the main toolbar or press Shift+F10.

  • Press Alt+Shift+F10, select the desired run configuration from the list, and press Enter.

    Run configuration popup

View responses from web services

When you execute an HTTP request, PhpStorm automatically saves the response into a separate file under the .idea/httpRequests/ directory. You can view the 50 most recently stored responses and navigate to the corresponding files using the requests history. If the request was executed from a scratch file, the link to its response output is also added below the original request:

HTTP response

View a received response

  1. Switch to the Services tool window, which opens automatically as soon as a response is received.

  2. By default, the server response is shown in the format specified in the request header via the content-type field. To have the response converted into another format, click Response view settings and select Text, JSON, XML, or HTML.

    HTTP response in the Services tool window

If the response contains a binary file, this file is also saved under the .idea/httpRequests/ directory. If the response is an image, you can see its preview in the Services tool window.

HTTP response with an image

If you have a response handler script, the results of the tests executed as part of this script are displayed on the Tests tab of the Services tool window.

The Tests tab of the Services tool window

If you subscribe to an event stream, PhpStorm displays events in the Services tool window. Here, you can also view the status of the client-server connection and terminate it by clicking Stop. Depending on the content type (either text/event-stream or application/x-ndjson), the response will be formatted as plain text or newline-delimited JSON. You can write a response handler script to process each line of the event stream.

Server-sent events

Redirecting stream events to a file is currently not supported.

Open a response file in the editor

  1. Position the caret at the link to the response you want to open.

  2. Choose View | Jump to Source from the main menu, or press Ctrl+B or F4

Alternatively, you can Ctrl+Click the response line:

Compare responses in a scratch file

When a request is executed from a scratch file, the link to the response output file is added below the original request.

  • Do any of the following:

    • Position the caret at the link to the response file. Press Alt+Enter and select the Compare with <response name> intention action.

    • Click Compare responses in the gutter and select Compare with <response name> from the list:

      Compare responses in request history

Compare responses in the request history

When a request is executed from a physical file, the link to the response output is added to the requests history.

  1. Position the caret at the link to the response file. Choose View | Jump to Source from the main menu, or press Ctrl+B or F4 to open this file in a new editor tab.

  2. Choose View | Compare With from the main menu, or press Ctrl+D. PhpStorm will prompt you to open a response file from the httpRequests folder.

  3. Select the response file you would like to compare the current file with and click Open.

The two response files will be opened in the Differences viewer allowing you to compare their contents:

Compare HTTP responses

View request history

PhpStorm automatically saves the 50 recently executed requests into the http-requests-log.http file, which is stored on the project level under the .idea/httpRequests/ directory. With requests history, you can quickly navigate to a particular response as well as issue any request again. If a request is issued again from the request history, its execution information and the link to the response output are added to the top of the request history file.

Open request history

  • Click Show HTTP request history on top of the request's editor panel.

  • Select Tools | HTTP Client | Show HTTP Requests History from the main menu.

Redirect output to a custom file or directory

  • The HTTP Client can redirect output to a custom file or directory. It supports two operators for force and soft redirects:

    • The >> operator always creates a new file, adding an -n suffix to a filename if the requested filename already exists.

    • The >>! operator rewrites the file if it already exists.

Manage cookies

The cookies received through a response are automatically saved into the dedicated http-client.cookies file under the .idea/httpRequests/ directory. The number of cookies that can be saved is limited to 300. The name and value of a cookie are automatically included in each subsequent request to the URL that matches the domain and path specified for the cookie, provided that the expiry date has not been reached.

the http-cookies file

If you want to set custom cookies in an HTTP request, you can use the Cookie header. Enter your cookies as a list of name=value pairs separated by a semicolon, for example:

GET http://localhost:80/api Cookie: theme=dark; country=France

WebSocket requests

The HTTP Client supports WebSocket requests. For the HTTP Client to treat your request as a WebSocket request, start it with the WEBSOCKET keyword followed by a server address. The request has the following structure:

WEBSOCKET ws://localhost:8080/websocket Content-Type: application-json // Used for content highlighting only // Request body, for example: { "message": "First message sent on connection" } === // message separator { "message": "Second message" // will be sent right after the previous one } === wait-for-server // keyword used to wait for the server response { "message": "Send this after the server response" }

To speed up composing a WebSocket request, you can:

  • Click App general add on top of the editor panel of an .http file and select WebSocket Request.

  • In an .http file, type wsr and press Enter to apply the WebSocket live template.

Send multiple messages

  • Use the === separator to send multiple messages:

    { "message": "First message sent on connection" } === // message separator { "message": "Second message" } === { "message": "Third message" }

Send messages after the server response

  • Before a message, enter === wait-for-server.

    This will make the HTTP Client wait for the server response before sending the message. You can wait for multiple responses by repeating the === wait-for-server line. For example, the following message will be sent after 3 server responses:

    === wait-for-server === wait-for-server === wait-for-server { "message": "This messages is sent after 3 server responses" }

Send messages interactively

Once you have initiated a connection, you can interact with your server right from the Services tool window. You can send messages and view server responses to each new message.

  1. In the Services tool window, select an opened connection.

  2. In the lower part of the window, under Message to be sent to WebSocket, enter the message content.

  3. To the right of it, select the message format: plain text, JSON, XML, or HTML.

  4. Press Ctrl+Enter to send the request.

In the upper part of the window, you'll see the server response.

The Services tool window

GraphQL

PhpStorm provides support for sending GraphQL operations in the HTTP request body. You can send them over HTTP or WebSocket.

Compose an HTTP request with GraphQL query

  1. In an .http file, enter the GRAPHQL keyword followed by a server address.

  2. In the request body, compose your GraphQL operation (query, mutation, or subscription), for example:

    ### HTTP request with GraphQL query GRAPHQL http://localhost:8080/graphql query { toDos { title, completed, author { username } } }

To speed up composing an HTTP request with a GraphQL query, you can:

  • Click App general add on top of the editor panel of an .http file and select GraphQL Query Request.

  • In an .http file, type gqlr and press Enter to apply the GraphQL live template.

Use GraphQL variables

In the HTTP request body, you can use GraphQL variables if you want to pass some dynamic data separately from the query string.

  • After the query part, enter a JSON variables dictionary:

    query ($name: String!, $capital: String!) { country(name: $name, capital: $capital) { name capital } } { "name": "France", "capital": "Paris" }

    You can also use HTTP Client environment variables as GraphQL variable values. For example, in this JSON, "{{Author}}" is an environment variable; its value at runtime depends on the environment that you select while sending the request:

    { "author": "{{Author}}" }

Configure proxy settings

  1. In the Settings/Preferences dialog (Ctrl+Alt+S), choose System Settings under Appearance & Behavior, then choose HTTP Proxy.

  2. In the HTTP Proxy dialog that opens, select Manual proxy configuration and specify the following:

    • Enter the proxy host name and port number in the Host name and Port number fields.

    • To enable authorization, select the Proxy authentication checkbox and type the username and password in the corresponding fields.

Set up client SSL/TLS certificate

If an HTTP server requires SSL/TLS authentication for secure communication, you may need to specify the client certificate before sending an HTTPS request. In the HTTP Client, you can set up the client certificate using the private environment file.

Specify path to certificate

  1. In an .http file, in the Run with list, select Add Environment to Private File….

  2. In the http-client.private.env.json file that opens, add the SSLConfiguration object to the needed environment. In clientCertificate, enter a path to your client certificate. If a certificate key is stored in a separate file, enter its path in clientCertificateKey. For example:

    { "dev": { "MyVar": "SomeValue", "SSLConfiguration": { "clientCertificate": "cert.pem", "clientCertificateKey": "MyFolder/key.pem" } } }

    Alternatively, you can describe clientCertificate and clientCertificateKey as objects, which lets you specify the certificate format in addition to the path. For example:

    { "dev": { "SSLConfiguration": { "clientCertificate": { "path": "file.crt", "format": "PEM" }, "clientCertificateKey": { "path": "file.key", "format": "DER" } } } }

Set up a certificate passphrase

If you used a passphrase when generating your client certificate, you should provide it to the HTTP Client.

  1. In the http-client.private.env.json file, add "hasCertificatePassphrase": true to the SSLConfiguration object, for example:

    { "dev": { "SSLConfiguration": { "clientCertificate": "file.crt", "hasCertificatePassphrase": true } } }
  2. Click App actions edit in the gutter or, with the caret placed at hasCertificatePassphrase, press Alt+Enter and select Set value for 'Certificate passphrase'.

  3. In the window that opens, enter your certificate passphrase.

HTTP Client Secured Value window

You can omit the second step if you do not want to enter the passphrase now. In this case, PhpStorm will prompt you to enter the passphrase when you execute an HTTPS request.

Disable certificate verification

For development purposes, you may have a host with self-signed or expired certificates. If you trust this host, you can disable verification of its certificate.

  • In the http-client.private.env.json file, add verifyHostCertificate": false to the SSLConfiguration object. For example:

    { "sslTest": { "SSLConfiguration": { "verifyHostCertificate": false } } }

If you run a request with this environment, PhpStorm will not verify host certificates.

Last modified: 12 September 2022