Language Design

A Bru file is made up of blocks. There are three kinds of blocks

• Dictionary block
• Text block
• Array block

Dictionary block

A dictionary block contains a set of key value pairs.

get {
  url: https://api.textlocal.in/send
}

headers {
  content-type: application/json
  Authorization: Bearer 123
  ~transaction-id: {{transactionId}}
}

Any key in the dictionary block can be prefixed with ~ to indicate that it is disabled.

Text block

A text block is a set of lines

body {
  {
    "hello": "world"
  }
}

tests {
  expect(res.status).to.equal(200);
}

Array block

An array block is a list of strings

vars:secret [
  access_key,
  access_secret,
  ~transactionId
]

Any key in the array block can be prefixed with ~ to indicate that it is disabled.

Comments

The Bru markup language does not have a dedicated comment syntax. To keep an entry in a file without it taking effect, prefix it with ~ to disable it:

headers {
  content-type: application/json
  ~transaction-id: {{transactionId}}
}

The content of script:pre-request, script:post-response, and tests blocks is JavaScript, so standard JavaScript comments (// and /* */) work inside those blocks.

To document a request, use the docs block or the Docs tab in the app.