How to create a local list of API requests with Bruno

Metadata Retrieval Interfaces for Machines
,
1

If you would like to have quick access to a customized list of API requests or want a faster way to test the REST API locally, there are several options. We have been experimenting with an open source API client called Bruno.

Bruno is local first, so instead of syncing to the cloud, Bruno stores your requests as plain text files (Markdown or YAML) on your device. This means that you can keep them in a local folder, version them with Git, or just edit them in your preferred text editor.

To get set up:

  1. Open Bruno, click the + icon, then click “Import Collection”.

  2. Select :broken_chain:URL, paste the URL of our REST API documentation (https://api.crossref.org/swagger-docs), and click import.

  3. The next dialogue box should automatically name this collection “Crossref REST API”. Select the directory where you want to store this collection, and choose between Tags or paths.

  4. If you choose Tags, your collection will include a subfolder for each endpoint with a list of example queries.

  5. If you choose Paths, your collection will include subfolders representing variables for different endpoints

  6. Click Import, and you should see your new collection ready for you to try out.

Example:

  1. Navigate to the works folder and click the + icon on the main panel to start a new request
  2. Paste https://api.crossref.org/works, and click Send

To access our polite pool with higher rate limits, let’s include your email and save it as a variable that can be reused:

  1. Go to the “Params” tab and in the table include the name “mailto”, and in Value, add your email address.
  2. Now, click the collection title and open the Vars tab. Here you can store values that you use repeatedly for quick access, and this will be valid for all the requests inside this folder.
  3. In the Pre Request table, include the variable “mailto” with your email address.

Bruno is local, so if you want to clear your collection, just navigate to the relevant folder on your device and delete the .bru or .yaml files you don’t need.

We hope this helps you to get started with using our REST API! Let us know if you find this useful and if you have tried other tools that help with making API requests.

1 Like