Requests

Requests are the basic building block in Beau. These define a particular HTTP request, it's properties, dependencies and content. They can be composed together to make more complex requests that might depend on another's value to complete.

Any key formatted as METHOD /path is considered a request by Beau. If they have an alias they are requestable by the Beau CLI and by other requests. They can be composed with other requests and configured to send along a given payload, parameters and headers when requested.

Here's an example:

POST /post/:
  alias: post
  params:
    id: 25
  headers:
    authentication: "Bearer token"
  payload:
    name: David
    lastname: Diaz

Sometimes you might need to make calls to the same METHOD /path combination, in those cases you can list multiple sets of configurations underneath the key. For example, if you wanted to test an endpoint with an optional payload value you could do it like this:

POST /path:
  - alias: first
    payload:
      optional: true
  - alias: second

In this case you can call either first or second and still be referring to the same path while avoiding key collisions.

Key

The key has to be formatted as <method> <path>, where the method is any valid HTTP method (GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH) followed by a path. The path will be appended to the current endpoint when being requested.

These are all valid keys:

POST /path: ...
GET /path: ...
PATCH /path: ...
PUT /path: ...

The <path> can also be a full URL. If it is, the endpoint will be ignored for that particular request. This is useful for one-off requests to a separate api.

Reusing a Path

If you want to reuse a path for a request with different settings you can pass an array of parameters to the path. Each one will be it's own request.

...

GET /users:
  - alias: get-users-without-auth

  - alias: get-users
    headers:
      Authentication: Bearer $session.body.token

Options

If you pass a string as the value instead of an object, that string will be used as an alias.

Alias

The alias is what you will use to call the request from the CLI and what you'll use to compose requests together. It ideally is something short and easy to type. It allows special characters but if you expect to compose a given request you should avoid using dots.

---
alias: name

Headers

The headers settings allow you to set any headers you want to send along with the HTTP request. You can pass an unlimited number of key-value pairs.

...
    headers:
        authentication: "Bearer token"
        some-other: header

Params

The params settings allow you to define any parameters you'd like to send as part of your request. These parameters are added to the query string of the request.

...
    params:
        id: 25
        order: ASC

Payload

The payload is where you set the request's body. It will be converted to json automatically if given an object, otherwise you can send text.

You shouldn't use this with Form or FormData as they'll override each other.

...
    payload:
        id: 25
        order: ASC

---
payload: "Hello World!"

Form

The form key automatically changes the request so that its content is a URL-Encoded form. All key-values are encoded and sent as the payload. The Content-Type header is set to application/x-www-form-urlencoded accordingly.

You shouldn't use this with Payload or FormData as they'll override each other.

...
    form:
        name: David
        lastname: Diaz

FormData

The FormData key automatically changes the request so that its content is a multipart/form-data form. It's Content-Type header is set accordingly. This is mainly used if you want to upload file and submit other binary data. Do not pass a null value, it'll cause the request to fail.

You shouldn't use this with Payload or Form as they'll override each other.

...
    formdata:
        name: David
        lastname: Diaz