http://api.my-example-site.com

PUT /my-endpoint HTTP/1.1
Host: api.my-example-site.com

Accept: text/plain
Accept-Charset: utf-8
X-custom-header: whatever you want

Here is the payload for the PUT request. Just add an empty line after the headers.

git clone https://github.com/pjdietz/rester-sublime-http-client.git "RESTer HTTP Client"

GET /my-endpoint HTTP/1.1
Host: api.my-example-site.com

GET http://api.my-example-site.com/my-endpoint

http://api.my-example-site.com/my-endpoint

api.my-example-site.com/my-endpoint

With new lines

Indented, using colons, and only using ?

#### Percent Encoding

One thing to note is that RESTer assumes that anything you place directly in the request line is the way you want it, but query parameters added on individual lines are assumed to be in plain text. So, values of query parameters added on individual lines are percent encoded.

These requests are equivalent:

### Body

To supply a message body for POST and PUT requests, add an empty line after the last header. RESTer will treat all content that follows the blank line as the request body.

Here's an example of adding a new cat representation by supplying JSON:

#### Form Encoding

For `application/x-www-form-urlencoded` requests, you can use the `auto_form_encode` command (part of RESTer) to automatically encode a body of key-value pairs. To use this functionality, make sure that `auto_form_encode` is enabled as a [`request_command`](#request-commands) and include a `Content-type: application/x-www-form-urlencoded` header.

The key-value pairs must be on separate lines. You may use `=` or `:` to separate the key from the value. As with query parameters, whitespace around the key and value is ignored.

Example:

Colons and whitespace

name: Molly
 color: Calico

##### Multiline Values

Use delimiters to mark the boundaries of multiline field values. By default, the delimiters are `"""` to mimic a triple-quoted Python string. You may customize this by providing values for the `form_field_start` and `form_field_end` settings.

Here's an example of a request using mixed single- and multiline fields.

### Comments

You may include comments in your request by adding lines in the headers section that begin with `#`. RESTer will ignore these lines.

## Settings

RESTer has some other features that you can customize through settings. To customize, add the desired key to the user settings file.

You may also provide configuration settings for the current request by adding lines to the headers section that begin with `@`.

The format of the line is `@{name}: {value}` where `{name}` is the key for a setting and `{value}` is the value. The value is parsed as a chunk of JSON.

### Displaying the Response and Request

By default, RESTer outputs the request and response to the console and opens a new buffer where it writes the full contents of the response. This view is created in the same group as the request view. You can change this behavior by tweaking several settings.

Setting                 | Default | Description
----------------------- | ------- | -----------
output_request          | `true`  | Write the request to the console.
output_response_headers | `true`  | Write the status line and headers to the console.
output_response_body    | `true`  | Write the body of response to the console. **Note**: because [response commands](#response-commands) must by run in a buffer, the body is not processed.
response_buffer         | `true`  | Open a new buffer, write the response, and run any number of [response commands](#response-commands) on the response body.
response_group          | `null`  | Set to the integer index of the group the response should appear in. `1` is the typical choice for a two-column presentation.
response_group_clean    | `false` | If indicating a specific response_group, close all other views in that group on each response.
request_focus           | `false` | Return focus to the request view after displaying the response.
body_only               | `false` | When writing the response to the buffer, do not include headers.

#### Side-by-Side Mode

If you'd like to author your request in one panel and view your response in a second, use this configuration:

```json
{
    "response_group": 1,
    "response_group_clean": true,
    "request_focus": true
}

{
    "protocol": "https"
}

GET https://api.my-secure-example-site.com/my-endpoint

GET /my-endpoint
Host: api.my-secure-example-site.com
@protocol:https

GET /my-endpoint
Host: api.my-example-site.com
@host: 127.0.0.1

GET /my-endpoint
Host: api.my-example-site.com
@host: 127.0.0.1
@port: 8888

{
    "default_headers": {
        "Accept-Encoding": "gzip, deflate",
        "Cache-control": "no-cache"
    }
}

{
    "default_response_encodings": ["utf-8", "ISO-8859-1", "ascii"]
}

{
    "response_commands": ["pretty_json"]
}

>>> view.command_history(0)
('insert', {'characters': '\n\n'}, 1)

>>> view.settings().get("syntax")
'Packages/HTTP Spec Syntax/httpspec.tmLanguage'

{
    "response_commands": [
        {
            "name": "set_syntax",
            "args": {
                "syntax_file": "Packages/HTTP Spec Syntax/httpspec.tmLanguage"
            }
        }
    ]
}

{
    "request_commands": ["merge_variables"]
}

GET http://{{API}}/my-endpoint

GET http://dev.my-example-site.com/my-endpoint

GET http://api.my-example-site.com/my-endpoint

{
    "name": "merge_variables",
    "args": {
        "active_sets": ["mysite", "mysite-dev"]
    }
}

{
    "follow_redirects": true,
    "follow_redirect_status_codes": [300, 301, 302, 303, 307]
}

{
    "http_client": "curl",
    "curl_command": "C:/curl/curl.exe",
    "curl_options": ["--header", "X-custom-header: header-value"]
}