REST Client for Visual Studio Code

REST Client allows you to run curl commands directly. The extension automatically parses the command.

Supported cURL options:

• -X, --request
• -L, --location, --url
• -H, --header (Note: no @ support in headers)
• -I, --head
• -b, --cookie (Note: no cookie jar file support)
• -u, --user (Basic auth support only)
• -d, --data, --data-ascii, --data-binary, --data-raw

In the response preview tab, use the icons in the upper right corner:

• Save Full Response: Saves the entire response to a local file. You will be prompted to choose a file path.
• Save Response Body: Saves ONLY the response body. The file extension is determined by the response MIME type (e.g., .json for application/json).

You can customize MIME type to extension mappings in settings using rest-client.mimeAndFileExtensionMapping.

"rest-client.mimeAndFileExtensionMapping": {
    "application/atom+xml": "xml"
}

To store and execute multiple requests in one file, use ### (three or more # symbols) as a delimiter between requests. Place your cursor between the delimiters to target a specific request.

GET https://example.com/comments/1 HTTP/1.1

###

GET https://example.com/topics/1 HTTP/1.1

###

POST https://example.com/comments HTTP/1.1
content-type: application/json

{
    "name": "sample"
}

File variables are constant throughout a single .http file.

• Definition: Use the syntax @variableName = variableValue on a complete line. Variable names must not contain spaces.
• Scope: Once defined, they can be referenced in any request within the same file using {{variableName}}.
• Special Characters: Use a backslash \ to escape special characters like line breaks (e.g., \n).
• Percent Encoding: When referencing a file variable, you can use the % symbol to percent-encode the value: {{%variableName}}.

@hostname = api.example.com
@port = 8080
@host = {{hostname}}:{{port}}
@contentType = application/json

###

@name = Strunk & White

GET https://{{host}}/authors/{{%name}} HTTP/1.1

To quickly obtain the cURL format of an existing HTTP request and copy it to your clipboard:

1. Press F1 and select Rest Client: Copy Request As cURL.
2. Alternatively, right-click in the editor and select Copy Request As cURL.

You can send HTTP requests directly from the editor using several methods:

• CodeLens: Click the Send Request link that appears above the request block (requires the file language mode to be set to HTTP).
• Keyboard Shortcut: Press Ctrl+Alt+R (or Cmd+Alt+R on macOS).
• Command Palette: Press F1 and select/type Rest Client: Send Request.
• Context Menu: Right-click in the editor and select Send Request.

Note: Shortcuts are only available when using http or plaintext language modes.

Responses are previewed in a separate webview panel. To preview responses in an untitled document instead, set the setting rest-client.previewResponseInUntitledDocument to true.

POST https://example.com/comments HTTP/1.1
content-type: application/json

{
    "name": "sample",
    "time": "Wed, 21 Oct 2015 18:27:50 GMT"
}

Auto-completion is available for the following categories while writing HTTP requests:

1. HTTP Methods
2. HTTP URLs from request history
3. HTTP Headers
4. System variables
5. Custom variables (defined in the current environment, file, or request)
6. MIME Types for Accept and Content-Type headers
7. Authentication schemes for Basic and Digest

REST Client saves the last 50 request items (method, URL, headers, and body) for future reference.

• View History: Press Ctrl+Alt+H (Cmd+Alt+H on macOS) or use F1 -> Rest Client: Request History. Selecting an item displays details in a temporary file.
• Clear History: Press F1 and select Rest Client: Clear Request History.

To quickly find specific requests or variables within a large .http file, use the VS Code 'Go to Symbol' feature.

Use the following shortcuts:

• Ctrl+Shift+O (macOS: Cmd+Shift+O)
• Or press F1 and type @

To install the REST Client extension in Visual Studio Code:

1. Press F1 to open the Command Palette.
2. Type ext install.
3. Search for rest-client and select it to install.