Quick Start

​

Prerequisites

• Basic idea of what HTTP and REST are
• Bruno installed (v3.x)
• Git (only needed for the Git challenge)
• Node.js (only needed for the CLI challenge)

​

Getting started

1. Fetch in Bruno button to open the collection in Bruno, or git clone the repository Bruno Starter Guide.

​

1. Create a collection

1. Open Bruno (workspace home).
2. Click + icon (top-left) → Create collection.

3. Enter a name Bruno Starter Guide (click on settings icon for advanced options) and choose the desired folder on your system.

4. Select file format (YAML or BRU -> YAML recommended) and click Create.

• Collection is visible in the sidebar with name Bruno Starter Guide.
• Collection is created with the desired file format (YAML recommended).

​

2. Create a request

1. Click on the collection contex menu (…) → create a New Request.

2. Select

• type HTTP - (GraphQL, gRPC, WebSocket, or cURL is also supported)
• Request Name as github-api
• URL as https://api.github.com/users/usebruno.

3. Send the request by clicking the arrow button or pressing Cmd/Ctrl + Enter.

• Status is 200 (Green text - 200 OK)
• Response body with details of the usebruno user.

​

3. Send a request with data

1. Create a new request with:
   • Request type as HTTP
   • Request name as echo-bru
   • method as POST
   • URL as https://echo.usebruno.com

2. Go to Body tab and select → JSON as a option

3. Add the following JSON data to the body of the request:

{
  "title": "Bruno",
  "msg": "Loved by developers. Built for developers."
}

3. Execute the request by clicking the arrow button or pressing Cmd/Ctrl + Enter.

• JSON data is sent to the API.
• Response body contains the same JSON data.

​

4. Create an environment

1. Open Environments settings (top-right — No environment).

2. Click on Create button in Collection section
3. Name the environment as local in environments popup

3. Add a below variable to the environment:
   • Name: baseURL
   • Value: https://echo.usebruno.com

3. click the Save button.
4. Go back to echo-bru request and set the URL to {{baseURL}} and select the local environment from the environment dropdown.

• Environment is created with the name local.
• Environment variable baseURL is added with the value https://echo.usebruno.com.
• Request echo-bru is executed successfully with the URL set to {{baseURL}}
• Response status is 200.

​

5. Write a test case

1. Open your echo-bru request.
2. Go to Assert tab and enter below details:

3. Execute the request and go to Tests tab in response section to confirm the assert passes (green).

4. Go to Tests tab in request section and copy and paste below snippet:

test("body has title", function () {
  expect(res.getBody()).to.have.property("title");
  });

test("200 status code", function () {
  expect(res.getStatus()).to.eql(200);
});

4. Execute the request (Cmd/Ctrl + Enter) and confirm tests pass (green).

• Assert and Tests passes (green) without any errors.

​

6. Write a script

1. Create a new request with:
   • Request type as HTTP
   • Request name as script-request
   • method as POST
   • URL as https://echo.usebruno.com

2. Go to tab Script → Pre-request and enter below snippet:

req.setBody({
  "name":"<your name>",
  "msg":"<your message>"
})

req.setHeader("Content-Type", "application/json");
req.setBody(body);
console.log(req.getName())

3. Execute the request and response body should be set to the body of the request.

• Script is executed successfully and console output is visible in the devtools.
• Response body is set to the body of the request with req.setBody() function.
• Header is set to the json content type with req.setHeader() function.

​

7. Authentication

1. Create a new request with:
   • Request type as HTTP
   • Request name as auth-request
   • method as GET
   • URL as https://httpbin.org/basic-auth/usebruno/1234

2. Go to request Auth tab and select Basic Auth from the Auth Type dropdown list.

3. Enter the username and password as usebruno and 1234 respectively.
4. Execute the request (Cmd/Ctrl + Enter).

• Authentication is set to the basic auth with the username and password.
• Response body contains the authenticated as true.

​

8. Collection Runner

1. Go to the collection context menu (…) and select Run.

2. Click on Configure requests to run and select all requests in the collection.

3. Click Run Selected Requests button to start the run.

• All requests are running one by one in the collection runner.
• Response status is 200 for all requests.
• Response body contains the data of the request.

​

9. API Documentation

1. Go to collection context menu (…) and select Generate Docs.

2. Click on the Generate button to generate automated API documentation.

3. Save the documentation file (html) to your desired location.

• API documentation is created for the collection.
• HTML file is generated with the content of the collection.

​

10. Git collaboration

1. Open the Git panel (top bar) and click Initialize to turn the collection folder into a repository.

2. Stage and commit your changes from the Git panel (or use git add / git commit in a terminal).

3. Go to GitHub
   • Create an empty repository (click on the + button and select New repository)
   • Enter name bruno-starter-guide and other details and copy the HTTPS URL
   https://github.com/yourusername/bruno-starter-guide.git
   
4. Go to collection Git panel and click on Remotes from bottom-left corner.

5. Click on Add Remote button and enter the following details:
   • Remote Name: origin
   • URL: https://github.com/yourusername/bruno-starter-guide.git

• Git repository is initialized for the collection.
• Remote repository is created and connected.
• Collection is pushed to the remote repository.

​

11. Run a request through the CLI

1. Install Bruno CLI:

npm install -g @usebruno/cli

2. Open terminal and Go to the Bruno Starter Guide collection (folder with bruno.json).

cd path/to/bruno-starter-guide

3. Run all requests:

bru run

4. Optional: run with a named environment e.g.

bru run --env local

• All requests are running one by one in the collection runner.
• Response status is 200 for all requests.
• Response body contains the data of the request.

​

12. OpenAPI specifications

1. Open the collection context menu (…) and select Share option.

2. Go to Export tab, select OpenAPI Specification option and click on Proceed button.

3. Enter the name of the file and location and click on Create button.

• OpenAPI file is created where you chose and opens without errors
• Export OpenAPI file with .yaml extension.

• Auth — Authentication
• Secrets — .env and secret managers
• Collection / request docs — Markdown in Docs tabs

​

Submit Challenge