Keyshade Alpha is launching April 30th 5:00 PM IST
Join our Launch Party
keyshade docs
GithubDiscordReddit
  • 👋What is keyshade?
  • Getting Started
    • Introduction
    • Adding your first secret and variable
    • Installing the CLI
    • Setting up your profile
    • Add keyshade to your project
    • Running your app
  • CLI
    • Introduction
    • Profile
    • Init
    • Workspace
    • Project
    • Environment
    • Run
    • Scan
  • 🥰CONTRIBUTING TO KEYSHADE
    • Summary
    • Design of our code
      • Organization of code
      • API
      • CLI
      • Web
      • Integrations
    • Prerequisites
    • Environment Variables
    • Setting things up
    • Running things locally
      • Running the API
      • Running the Web
      • Running the Platform
      • Running the CLI
      • API Testing
      • Docker Support
  • Internals
    • Architecture of keyshade
    • How the CLI works
Powered by GitBook
On this page
  • API Testing
  • Getting started
  • Making changes to the API

Was this helpful?

Edit on GitHub
  1. CONTRIBUTING TO KEYSHADE
  2. Running things locally

API Testing

PreviousRunning the CLINextDocker Support

Last updated 5 months ago

Was this helpful?

⁸--- 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 Bruno collection. You can find it in .

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

  • Once you have Bruno installed, open it up.

  • Click on Import Collection

  • 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

Point to the folder

Whenever you make a change to the API that adds / removes / updates one or more requests, you are required to update the corresponding collection in the folder. Since the collections are tracked in the branch, we expect you to make all the changes in the same branch which you are working on.

🥰
api-collection
api-collection
here
here
Download Bruno
Open Bruno
Import Collection
API Collection