Recipe Body

There are a variety of ways to define the body of your request. Slumber supports structured bodies for a fixed set of known content types (see table below). In addition to handling body serialization for you, structured bodies will also set the Content-Type header.

In addition, you can pass any Template to render any text or binary data. In this case, you'll probably want to explicitly set the Content-Type header to tell the server what kind of data you're sending. This may not be necessary though, depending on the server implementation.

Body Types

The following content types have first-class support. Slumber will automatically set the Content-Type header to the specified value, but you can override this simply by providing your own value for the header.

Variant	`Content-Type`	Description
`stream`	None	Instead of rendering an entire body eagerly, stream the bytes of the template to the server as they're rendered; more info
`json`	`application/json`	Structured JSON body; all strings are treated as templates
`form_urlencoded`	`application/x-www-form-urlencoded`	URL-encoded form data; more info
`form_multipart`	`multipart/form-data`	Binary form data; more info

JSON

JSON bodies can contain any data. All strings in the JSON are treated as templates.

Field	Type	Description	Default
`data`	Any	JSON content	Required

See the guide for more detail on how to use JSON bodies.

URL-encoded Form

URL forms can only pass text data.

Field	Type	Description	Default
`data`	`mapping[string, Template]``	Form fields	Required

See the guide for more detail on how to use form bodies.

Multipart Form

Multipart forms can pass text or binary data.

Field	Type	Description	Default
`data`	`mapping[string, Template]``	Form fields	Required

See the guide for more detail on how to use form bodies, and Multipart File Streaming for details on how data is streamed.

Examples

requests:
  text_body:
    method: POST
    url: "{{ host }}/fishes/{{ fish_id }}/name"
    headers:
      Content-Type: text/plain
    body: Alfonso

  binary_body:
    method: POST
    url: "{{ host }}/fishes/{{ fish_id }}/image"
    headers:
      Content-Type: image/jpg
    body: "{{ file('./fish.png') }}"

  json_body:
    method: POST
    url: "{{ host }}/fishes/{{ fish_id }}"
    # Content-Type header will be set automatically based on the body type
    body:
      type: json
      data: { "name": "Alfonso" }

  urlencoded_body:
    method: POST
    url: "{{ host }}/fishes/{{ fish_id }}"
    # Content-Type header will be set automatically based on the body type
    body:
      type: form_urlencoded
      data:
        name: Alfonso

  multipart_body:
    method: POST
    url: "{{ host }}/fishes/{{ fish_id }}"
    # Content-Type header will be set automatically based on the body type
    body:
      type: form_multipart
      data:
        name: Alfonso
        image: "{{ file('./fish.png') }}"