OpenAPI
Overview

OpenAPI and Bruno

Bruno allows you to work with OpenAPI Specification (OAS) files in a number of ways:

  • Creating a collection from an OAS file import
  • Exporting a collection as an OAS file
    PremiumBruno Logo
  • Viewing and Designing an OAS file
    PremiumBruno Logo

Creating a Collection from OAS Import

Bruno supports importing OAS V3 files only
  • Select Import
  • Choose OpenAPI V3 File

select-openapi-file

  • Select the file stored on your machine

Exporting a Collection as an OAS File
PremiumBruno Logo

  • Right-click on a collection and select Export

select-export

  • Choose OpenAPI Specification

select-openapi-from-export-menu

  • Name your file and designate a location for it to be stored

export-open-api

Viewing and Designing an OAS file
PremiumBruno Logo

If you've saved or otherwise have an OAS file on your machine, you can view the OAS in a SwaggerUI-esque manner by:

  • Selecting Open API Spec

open-open-api

  • Choose the file name and location that you want to open

This will then open the spec in a separate section of your Bruno sidebar called APIs.

If you want to create an OAS file, you can:

  • Select Create API Spec create-open-api

  • Designate whether you want to create a Blank Spec, or generate it from an existing Bruno Collection

location-open-api

  • Choose a name and location for the spec to be saved under.

You will now have the scaffolding of an OAS that you can continue to design.

location-open-api

RequestsOverview