OpenAPICreate an OpenAPI Spec

Create OpenAPI Specification (OAS)

Bruno provides a powerful interface for creating and managing OpenAPI Specifications (OAS). You can either design a new specification from scratch and view one as existing Open API spec.

Viewing Existing OAS Files

You can view and interact with existing OAS files in Bruno using a SwaggerUI-like interface:

  1. Open Bruno and Go to context menu (three dots)
  2. Select Open API Spec from dropdown

open-open-api

  1. Browse and select your OAS file (.yaml or .json)
  2. The specification will open in a dedicated section of your Bruno sidebar

view-open-api

Creating New OAS Files

  1. Open Bruno and Go to context menu (three dots)
  2. Select Create API Spec from dropdown

create-open-api

  1. Choose a name and location for your specification

location-open-api

  1. Click on Create to generate OAS file.

Editing Your OAS File

Once created, you can edit your OAS file in Bruno’s built-in editor:

  1. The editor provides syntax highlighting
  2. Use the sidebar to navigate through different sections of your API
  3. Add or modify endpoints, parameters, and responses
  4. Include examples and descriptions for better documentation

write-api-spec

Last updated on