diff --git a/blob/api_collection.png b/blob/api_collection.png new file mode 100644 index 00000000..d5690c27 Binary files /dev/null and b/blob/api_collection.png differ diff --git a/blob/download_bruno.png b/blob/download_bruno.png new file mode 100644 index 00000000..0f5e2a56 Binary files /dev/null and b/blob/download_bruno.png differ diff --git a/blob/import_collection.png b/blob/import_collection.png new file mode 100644 index 00000000..b1422f9f Binary files /dev/null and b/blob/import_collection.png differ diff --git a/blob/open_bruno.png b/blob/open_bruno.png new file mode 100644 index 00000000..6a83901b Binary files /dev/null and b/blob/open_bruno.png differ diff --git a/docs/contributing-to-keyshade/running-things-locally/api-testing.md b/docs/contributing-to-keyshade/running-things-locally/api-testing.md index c5ccbe37..8925968c 100644 --- a/docs/contributing-to-keyshade/running-things-locally/api-testing.md +++ b/docs/contributing-to-keyshade/running-things-locally/api-testing.md @@ -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