Import OpenAPI Specification (OAS)

Bruno provides seamless integration with OpenAPI Specification (OAS), allowing you to import API definitions through both files and URLs. This feature enables you to quickly create collections in Bruno by leveraging existing OpenAPI documentation.

Prerequisites

Before importing an OpenAPI specification, ensure you have:

• A valid OpenAPI V3 specification file (YAML or JSON format)
• Or a publicly accessible URL containing the OpenAPI specification

Import Methods

Bruno offers two ways to import OpenAPI specifications:

1. File Import: Import from a local OpenAPI specification file
2. URL Import: Import directly from a publicly accessible OpenAPI specification URL
3. Bruno Converter: Programmatically convert an OAS file to a Bruno collection by using our converter.

Importing from a File

1. Open Bruno and navigate to your collection
2. Click on the context menu (three dots) in the collections panel
3. Select Import from the dropdown menu
4. Choose OpenAPI V3 File option

5. Browse and select your OpenAPI specification file (.yaml or .json)
6. Click Import to create the collection

Importing from a URL

The import method for URL option is same as for URL but you need to select OpenAPI V3 URL as option and provide URL of OAS file which is publically available.

After, Importing the OAS file the sample collection will looks like this.

Example OpenAPI Specifications

You can test the import functionality using these example OpenAPI specifications:

1. Petstore API:
   • URL: https://petstore3.swagger.io/api/v3/openapi.json
   • Description: A sample API for a pet store