Skip to content

Commit

Permalink
docs: Add pictures to Bruno setup (#541)
Browse files Browse the repository at this point in the history
Signed-off-by: vr-varad <[email protected]>
  • Loading branch information
vr-varad authored Nov 18, 2024
1 parent bc3100b commit 210c0fd
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 3 deletions.
Binary file added blob/api_collection.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added blob/download_bruno.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added blob/import_collection.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added blob/open_bruno.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -1,19 +1,23 @@
---
---
description: API testing using Bruno
---

# API Testing

We use Bruno to test our APIs. All of our endpoints are tested using Bruno and we maintain a detailed documentation of every endpoint in our Postman collection. You can find the it in [here](../../../api-collection/).
We use Bruno to test our APIs. All of our endpoints are tested using Bruno and we maintain a detailed documentation of every endpoint in our Bruno collection. You can find it in [here](../../../api-collection/).

Although we recommend to use Bruno, you can always import the collections into your favorite tool.

## Getting started

- For starters, make sure you have Bruno installed on your system. If not, you can download it from [here](https://www.usebruno.com/downloads)
- Once you have Postman installed, open it up.
![Download Bruno](../../../blob/download_bruno.png)
- Once you have Bruno installed, open it up.
![Open Bruno](../../../blob/open_bruno.png)
- Click on `Import Collection`
![Import Collection](../../../blob/import_collection.png)
- Point to the [`api-collection`](../../../api-collection/) folder
![API Collection](../../../blob/api_collection.png)
- For every collection in the API, the requests hold one or more examples that you can use to test the API. You can also find the schema of the request itself.

## Making changes to the API
Expand Down

0 comments on commit 210c0fd

Please sign in to comment.