Bruno Docs (mirror)
OpenAPI and Bruno
Initializing search
    • Bruno Documentation
    • What is Bruno?
    • Overview
      • Response Visualization
      • Working with BigInt
        • Connect Anthropic
        • Configuration
        • Connect a Custom AI Provider
        • Bruno AI
        • Connect OpenAI
        • Using Bruno AI
        • Claude
        • Codex
        • Cursor
        • Devin
        • Overview
        • Use Cases
        • GitHub Copilot
      • API Client
      • Document a Collection
      • Document a Folder
      • API Documentation in Bruno
      • Document a Request
      • Document a Workspace
      • Using AI with Apps
      • API Reference
      • Configuring Apps
      • Examples
      • Overview
      • Adding and managing certificates
      • Akamai EdgeGrid
      • Authenticate using AWS Signature
      • Using Basic authentication
      • Authenticate with a Bearer token
      • Authenticate with Digest Access
      • Authenticate with NTLM
      • OAuth 1.0 authentication
      • Authentication in Bruno
        • How to Use OAuth2 for the Authorization Code Grant Type
        • How to Use OAuth2 for the Client Credentials Grant Type
        • Oauth 2.0 authentication in Bruno
        • How to Use OAuth2 for the Password Credentials Grant Type
        • How to Use OAuth2 for the Authorization Code Grant Type
        • How to Use OAuth2 for the Client Credentials Grant Type
        • OAuth 2.0 Configuration
        • OAuth 2.0 Authentication in Bruno
        • How to Use OAuth2 for the Password Credentials Grant Type
        • System Browser Support for OAuth 2.0
      • Azure DevOps Pipelines Integration
      • Docker Integration
      • Installation
      • Jenkins CI Integration
      • Bruno CLI
      • Proxy and mTLS
      • Quick Start
      • Secret Managers
        • bru docs options
        • bru docs
        • Pairing with Downstream Actions
        • Manual CLI Setup
        • GitHub Actions
        • bru import options
        • bru import
        • bru run options
        • bru run
        • Generating Reports
      • Language Design
      • Bru Markup Language
      • Samples
      • Syntax Highlighting Support
      • Bru Tag Reference
      • YAML Migration
      • API Reference
      • Insomnia to Bruno
      • OpenAPI to Bruno
      • Bruno Converters
      • Postman to Bruno
      • WSDL to Bruno
      • Dev Tools
      • Timeline
      • Request History
      • Safe Mode vs Developer Mode
        • Create a Collection
        • Create a Folder
        • Create a Request
        • Create a Test
        • Create a Workspace
        • Download & Install
        • Run a Collection
        • JavaScript Sandbox
        • Keybindings
        • Configuring Proxy Settings in Bruno
        • Settings
        • Exporting Collections
        • Import collections
        • Import Export Environment Variables
        • Import and Export Workspace
        • Postman Export Organizer
        • Migrating from Postman
        • Scripts Translator
      • Collaboration via Azure DevOps
      • Collaboration via Bitbucket
      • Fetch in Bruno Button
      • Choosing a Git Strategy
      • Collaboration via GitLab
      • Collaboration in Bruno
      • Collaboration via CLI
        • Consumer Guide
        • Collaboration via GUI
        • Provider
      • GitHub Provider
      • Git providers and Bruno
      • Deploy and Share
      • Environments in Generated Docs
      • Generate Documentation
      • Generated HTML Documentation
      • Interactive Playground
      • Search in Generated Docs
      • Feedback & Community
      • Getting Started
      • Manifesto
      • Quick Start
      • AI Policy
      • Billing
      • License Management Portal
      • Self Host Licensing
        • Configure SAML SSO with Microsoft Entra ID
        • Configure SAML SSO with Okta
        • SAML Single Sign-On (SSO) Overview
        • SAML SSO Troubleshooting
        • Bruno SCIM API
        • Microsoft Entra ID SCIM provisioning with Bruno
        • Okta SCIM provisioning with Bruno
        • SCIM Provisioning Overview
      • Activating Your License
      • Create a Mock Server
      • Mock Servers
      • Run a Mock Server
        • Mock Servers from OpenAPI
        • Mock Servers from Collection
      • Create OpenAPI Specification (OAS)
      • Export to OpenAPI Specification (OAS)
      • Import OpenAPI Specification (OAS)
      • OpenAPI Sync
      • OpenAPI and Bruno
      • Index
      • OpenCollection YAML Format
      • YAML Samples
      • YAML Structure Reference
      • Formats
      • DotEnv File
      • Secret Management
      • Secret Masking in Reports
      • Secret Variables
        • Migration Guide
        • Overview
          • Integrating AWS Secrets Manager
          • Configuring and Fetching Secrets
          • Overview
          • Using secrets in Request Fields
          • Integrating Azure Key Vault
          • Azure CLI Authentication
          • Configuring and Fetching Secrets
          • Overview
          • Using secrets in Request Fields
          • Integrating Google Cloud Secret Manager
          • Configuring and Fetching Secrets
          • Overview
          • Using secrets in Request Fields
          • Integrating HashiCorp Vault
          • Configuring and Fetching secrets
          • Overview
          • Using secrets
      • Request History
      • Overview
        • Body Data
        • Code Generator
        • Overview
        • Parameters
        • Request headers
        • Request Settings
        • REST API request
        • Server-Sent Events (SSE)
        • GraphQL Request
        • GraphQL Variables
        • Overview
        • Query builder
        • gRPC Proto Files
        • gRPC Request
        • gRPC Streams
        • Overview
        • gRPC Scripting
        • Cookies in Bruno
        • Response Data and Cookies
        • Response Data
        • Response Examples
          • Dev Tools
          • Timeline
        • SOAP API request
        • Create WebSocket Request
        • WebSocket Message Types
        • Overview
        • WebSocket Request Interface
        • Running Automated Tests
        • Iterate Using Data Files
        • Running Tests Manually
        • Overview
        • Dynamic Variables
        • External Libraries
        • Inbuilt Libraries
        • JavaScript API Reference
        • Creating a JS File in Bruno
        • Scripting
        • Request Chaining
        • Script Flow in Bruno
        • Vars tab
        • Whitelisting Modules
          • Request Object
          • Sync requests
          • Response object
          • Response query
        • Assertions
        • Testing
        • Bruno Translator Bundle
      • Overview
        • Bruno Starter Guide
        • Response Visualization
        • Working with BigInt
        • Document a Collection
        • Document a Folder
        • APIs Documentation
        • Document a Request
        • Adding and managing certificates
        • Authenticate using AWS Signature
        • Using Basic authentication
        • Authenticate with a Bearer token
        • Authenticate with Digest Access
        • Authenticate with NTLM
        • Authentication in Bruno
          • How to Use OAuth2 for the Authorization Code Grant Type
          • How to Use OAuth2 for the Client Credentials Grant Type
          • Oauth 2.0 authentication in Bruno
          • How to Use OAuth2 for the Password Credentials Grant Type
          • How to Use OAuth2 for the Authorization Code Grant Type
          • How to Use OAuth2 for the Client Credentials Grant Type
          • OAuth 2.0 Configuration
          • OAuth 2.0 Authentication in Bruno
          • How to Use OAuth2 for the Password Credentials Grant Type
        • Generating Reports
        • Command Options
        • GitHub Actions Integration
        • Import Data
        • Installation
        • Jenkins CI Integration
        • Bruno CLI
        • Proxy and mTLS
        • Running a Collection
        • Language Design
        • Bru Markup Language
        • Samples
        • Syntax Highlighting Support
        • Bru Tag Reference
        • Convert Insomnia collection to Bruno collection
        • Convert OpenAPI to Bruno collection
        • Bruno Converters
        • Postman Conversions
        • Convert WSDL to Bruno Collection
          • Creating a Collection
          • Create a Folder
          • Creating a Request
          • Create a Test
          • Download & Install
          • Run a Collection
          • JavaScript Sandbox
          • Configuring Proxy Settings in Bruno
          • Settings
          • Exporting Collections
          • Importing Collections
          • Import/Export Environments
          • Migrating from Postman
          • Scripts Translator
        • Collaboration via Bitbucket
        • Fetch in Bruno Button
        • Collaboration via GitLab
        • Collaboration in Bruno
        • Collaboration via CLI
          • Consumer
          • Collaboration via GUI
          • Provider
        • Feedback & Community
        • Manifesto
        • What is Bruno?
        • License Management Portal
          • Configure SAML SSO with Microsoft Entra ID
          • Configure SAML SSO with Okta
          • SAML Single Sign-On (SSO) Overview
          • SAML SSO Troubleshooting
          • Bruno SCIM API
          • Microsoft Entra ID SCIM provisioning with Bruno
          • Okta SCIM provisioning with Bruno
          • SCIM Provisioning Overview
        • Activating Your License
        • Create OpenAPI Specification (OAS)
        • Export to OpenAPI Specification (OAS)
        • Import OpenAPI Specification (OAS)
        • OpenAPI and Bruno
        • Secrets Management
        • Secret Management
        • Bruno Secret Masking in Reports
        • Secrets Management
          • Integration with Secret managers
            • Adding AWS Secrets Manager
            • Configuring and Fetching Secrets
            • AWS Secret Manager
            • Using secrets
            • How to Add a Secret Provider
            • Azure CLI Authentication
            • Configuring and Fetching secrets
            • Azure Key Vault
            • Using secrets
            • How to Add a Secret Provider
            • Configuring and Fetching secrets
            • HashiCorp Vault
            • Using secrets
            • Using with Bruno CLI
        • Request History
        • Sending Requests and Handling Responses in Bruno
          • Body Data
          • Code Generator
          • Overview
          • Parameters
          • Request headers
          • Request Settings
          • REST API request
          • GraphQL request
          • GraphQL Variables
          • Overview
          • gRPC Proto Files
          • gRPC Request
          • gRPC Streams
          • Overview
          • Cookies in Bruno
          • Response Data and Cookies
          • Response Data
          • Response Examples
            • Dev Tools
            • Timeline
          • SOAP API request
          • Create WebSocket Request
          • WebSocket Message Types
          • Overview
          • WebSocket Request Interface
          • Running Automated Tests
          • Iterate Using Data Files
          • Running Tests Manually
          • Overview
          • Dynamic Variables
          • External Libraries
          • Scripting
          • Inbuilt Libraries
          • JavaScript API Reference
          • Creating a JS File in Bruno
          • Request Chaining
          • Script Flow in Bruno
          • Vars tab
          • Whitelisting Modules
            • Request Object
            • Sync requests
            • Response Object
            • Response Query
          • Assertions
          • Testing
        • Collection Variables
        • Environment Variables
        • Folder Variables
        • Global Environment Variables
        • Variable Interpolation
        • Variables
        • Process Environment Variables
        • Request Variables
        • Runtime Variables
        • Install and Configure
        • Overview
        • Send Request
      • What is Bruno?
      • Overview
        • Response Visualization
        • Working with BigInt
        • Claude
        • Codex
        • Cursor
        • Overview
        • Use Cases
        • GitHub Copilot
        • Auto Generate Documentation
        • Document a Collection
        • Document a Folder
        • APIs Documentation
        • Document a Request
        • Document a Workspace
        • Adding and managing certificates
        • Authenticate using AWS Signature
        • Using Basic authentication
        • Authenticate with a Bearer token
        • Authenticate with Digest Access
        • Authenticate with NTLM
        • OAuth 1.0 authentication
        • Authentication in Bruno
          • How to Use OAuth2 for the Authorization Code Grant Type
          • How to Use OAuth2 for the Client Credentials Grant Type
          • Oauth 2.0 authentication in Bruno
          • How to Use OAuth2 for the Password Credentials Grant Type
          • How to Use OAuth2 for the Authorization Code Grant Type
          • How to Use OAuth2 for the Client Credentials Grant Type
          • OAuth 2.0 Configuration
          • OAuth 2.0 Authentication in Bruno
          • How to Use OAuth2 for the Password Credentials Grant Type
          • System Browser Support for OAuth 2.0
        • Generating Reports
        • Command Options
        • Docker Integration
        • Import Data
        • Installation
        • Jenkins CI Integration
        • Bruno CLI
        • Proxy and mTLS
        • Quick Start
        • Command Examples
          • Pairing with Downstream Actions
          • Manual CLI Setup
          • GitHub Actions
        • Language Design
        • Bru Markup Language
        • Samples
        • Syntax Highlighting Support
        • Bru Tag Reference
        • API Reference
        • Insomnia to Bruno
        • OpenAPI to Bruno
        • Bruno Converters
        • Postman to Bruno
        • WSDL to Bruno
        • Dev Tools
        • Timeline
        • Request History
        • Safe Mode vs Developer Mode
          • Create a Collection
          • Create a Folder
          • Create a Request
          • Create a Test
          • Create a Workspace
          • Download & Install
          • Run a Collection
          • JavaScript Sandbox
          • Configuring Proxy Settings in Bruno
          • Settings
          • Exporting Collections
          • Import collections
          • Import Export Environment Variables
          • Import and Export Workspace
          • Migrating from Postman
          • Scripts Translator
        • Collaboration via Azure DevOps
        • Collaboration via Bitbucket
        • Fetch in Bruno Button
        • Choosing a Git Strategy
        • Collaboration via GitLab
        • Collaboration in Bruno
        • Collaboration via CLI
          • Consumer Guide
          • Collaboration via GUI
          • Provider
        • GitHub Provider
        • Git providers and Bruno
        • Feedback & Community
        • Getting Started
        • Manifesto
        • Quick Start
        • Billing
        • License Management Portal
        • Self Host Licensing
          • Configure SAML SSO with Microsoft Entra ID
          • Configure SAML SSO with Okta
          • SAML Single Sign-On (SSO) Overview
          • SAML SSO Troubleshooting
          • Bruno SCIM API
          • Microsoft Entra ID SCIM provisioning with Bruno
          • Okta SCIM provisioning with Bruno
          • SCIM Provisioning Overview
        • Activating Your License
        • Create OpenAPI Specification (OAS)
        • Export to OpenAPI Specification (OAS)
        • Import OpenAPI Specification (OAS)
        • OpenAPI Sync
        • OpenAPI and Bruno
        • Index
        • OpenCollection YAML Format
        • YAML Samples
        • YAML Structure Reference
        • DotEnv File
        • Secret Management
        • Secret Masking in Reports
        • Secret Variables
          • Integration with Secret managers
            • Adding AWS Secrets Manager
            • Configuring and Fetching Secrets
            • AWS Secret Manager
            • Using secrets in Request Fields
            • Adding Azure Secret Manager
            • Azure CLI Authentication
            • Configuring and Fetching secrets
            • Azure Key Vault
            • Using secrets in Request Fields
            • Adding HashiCorp Vault Secret Manager
            • Configuring and Fetching secrets
            • HashiCorp Vault
            • Using secrets
            • Using with Bruno CLI
        • Request History
        • Overview
          • Body Data
          • Code Generator
          • Overview
          • Parameters
          • Request headers
          • Request Settings
          • REST API request
          • GraphQL Request
          • GraphQL Variables
          • Overview
          • Query builder
          • gRPC Proto Files
          • gRPC Request
          • gRPC Streams
          • Overview
          • Cookies in Bruno
          • Response Data and Cookies
          • Response Data
          • Response Examples
            • Dev Tools
            • Timeline
          • SOAP API request
          • Create WebSocket Request
          • WebSocket Message Types
          • Overview
          • WebSocket Request Interface
          • Running Automated Tests
          • Iterate Using Data Files
          • Running Tests Manually
          • Overview
          • Dynamic Variables
          • External Libraries
          • Scripting
          • Inbuilt Libraries
          • JavaScript API Reference
          • Creating a JS File in Bruno
          • Request Chaining
          • Script Flow in Bruno
          • Vars tab
          • Whitelisting Modules
            • Request Object
            • Sync requests
            • Response Object
            • Response Query
          • Assertions
          • Testing
        • Collection Variables
        • Environment Variables
        • Folder Variables
        • Global Environment Variables
        • Variable Interpolation
        • Variables
        • Process Environment Variables
        • Prompt Variables
        • Request Variables
        • Runtime Variables
        • Install and Configure
        • Overview
        • Send Request
      • Collection Variables
      • Environment Variables
      • Folder Variables
      • Global Environment Variables
      • Variable Interpolation
      • Variables
      • Process Environment Variables
      • Prompt Variables
      • Request Variables
      • Runtime Variables
      • Install and Configure
      • VS Code
      • Send Request

    OpenAPI and Bruno

    OpenAPI Specification (OAS) is a standard format for reading and describing HTTP APIs. This allows people to understand how an API works, how a sequence of APIs work together, generate client code, create tests, apply design standards, and more.

    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
    • Viewing and Designing an OAS file
    Made with Material for MkDocs