Bruno uses plain-text files organized in related folders, in order to declare an API client tester.

[avelino]

Discussed in #186

^{Originally posted by matheusfrancisco December 4, 2023}
Bruno uses plain-text files organized in related folders, in order to declare an API client tester.

schema: https://bruno-docs.vercel.app/bru-language-tag-reference.html
real use case: https://github.com/usebruno/github-rest-api-collection/tree/main

The root folder needs a json file with the content as follows:

{
  "version": "1",
  "name": "<<the name of my rest api>>",
  "type": "collection"
}

every subsequent file can contain the following:

meta

info about the request

meta {
  name: Get users,
  type: http
  seq: 1
}

A method

which can be any of get, post, put, delete, options, trace, connect and head.

[get/post/put/delete/options/trace/connect/head] {
  url: https://api.github.com/users/usebruno
}

Query Params

optional

query {
  something: hello
  anotherThing: bye
  aThirdThing: hi again
}

Head Params

optional

headers {
  content-type: application/json
  Authorization: Bearer topsecret
}

Body

optional

The body can be of any type within text, xml, form-encoded, json, multipart-form, graphql, pre-request and post-request

body:text {
  This is a text body
}

cc: @J0sueTM