Bruno API Client Full Walkthrough 🚀 | Complete Beginner's Guide to All Features! #opensource

Introduction to Bruno: The Open Source API Client

Overview of the Video

• This video introduces Bruno, an open-source API client designed for developers. It aims to explain its features, usage, and advantages over other API testing clients.

• The target audience includes beginners interested in understanding and contributing to Bruno as an open-source project.

Key Features of Bruno

• Open Source Nature: Bruno is built as an open-source product, allowing community contributions and feedback which enhances its development. This approach fosters collaboration among developers.

• Data Privacy and Security: As a fully offline application, Bruno ensures that user credentials are stored locally rather than in the cloud, minimizing risks associated with data breaches or unauthorized access.

• Git Integration: Unique to Bruno is its integration with Git for version control, enabling users to track changes in their API collections just like they would with source code. This feature supports better collaboration among team members.

• File System Based: All data created within Bruno is stored on the local file system, reinforcing its offline capabilities and ensuring that sensitive information remains secure from external threats.

• Scripting Capabilities: Users can execute any npm package through scripting within Bruno, allowing for extensive automation and manipulation of data during API testing scenarios. This flexibility sets it apart from other clients.

Getting Started with Installation

Installation Process

• To install Bruno, users should visit the official website (usbr.com) and navigate to the download section for the latest version of the app. A recent major release has been noted for improvements in functionality.

• Specific instructions are provided for Mac users regarding installation via a package manager called "brie," along with additional resources available through previous videos detailing setup processes.

Bruno Interface Overview

Introduction to Bruno's Interface

• The Bruno interface is divided into two sections: a sidebar on the left and main content on the right, simplifying navigation for users.

Sidebar Options

• The sidebar includes a context menu with options such as creating a collection, which allows users to name and store their collections easily.

• Users can open existing collections from their system by selecting the "open collection" option in the context menu.

Importing Collections

• Users can import collections from other tools like Postman or Insomnia through the context menu, facilitating migration of existing data.

• A demonstration shows how to import a random Postman collection into Bruno, highlighting its compatibility with various formats.

OpenAPI Integration

• Users can also open OpenAPI v3 files directly within Bruno. An example using a popular Pet Store API illustrates this functionality.

Debugging Tools in Bruno

Dev Tools Overview

• Bruno provides debugging tools similar to Chrome's developer console, allowing users to inspect requests and troubleshoot issues effectively.

Console Features

• Developers can write scripts within any request to log values in the console for easier debugging.

Additional Development Tools

Built-in Utilities

• Bruno offers several built-in tools for developers including JSON-to-YAML conversion, JSON beautification (pifying), and JWT decoding functionalities.

JSON and YAML Conversion

• Users can convert JSON data to YAML format directly within Bruno without needing external applications.

JWT Decoding

• The platform allows users to decode JWT tokens easily by inputting them into the provided field.

Creating Custom API Specifications

Designing APIs in Bruno

• Users have the capability to create custom API specifications by writing YAML configurations directly within the interface.

Introduction to Bruno and Open API

Overview of Bruno's Functionality

• The introductory section encourages users to explore the creation of an Open API and design their projects, with outputs visible in Bruno.

• Bruno utilizes Swagger UI for displaying API specifications in YAML or JSON formats, enhancing user experience by providing a visually appealing interface.

• Open API documentation simplifies understanding of APIs, showcasing various endpoints and functionalities effectively.

Key Features of Collections

• Collections are crucial for working within Bruno; users can create new collections or import existing ones from Postman or GitHub.

• Users can reorder collections alphabetically (A-Z or Z-A), facilitating better organization and accessibility of API requests.

Search and Settings Options

• A search panel allows users to find specific collections easily, improving navigation through numerous entries.

• The sidebar includes settings for display preferences, proxy configurations, license management, and cookie handling.

Collection Management in Bruno

Collection Level Settings

• Common tabs across folders and requests include preset configurations, proxy settings, client certifications, secrets, and request management options.

• Documentation can be formatted using Markdown language within the overview page; it supports headers, tables, images, etc., enhancing clarity.

Header Management

• Headers can be set at the collection level rather than individually for each request or folder. This streamlines processes like authentication by applying common headers universally.

Variables and Authentication

• Users can define collection-level variables that are accessible across all requests within that collection.

• Authentication requirements can also be managed at the collection level to ensure consistency across multiple requests.

Advanced Features: Presets in Requests

Utilizing Presets Effectively

• Presets allow users to save common request parameters which can be reused when creating new requests within a collection.

• If presets are not utilized properly during request creation, users may need to manually input details repeatedly—highlighting the importance of this feature for efficiency.

Proxy Settings and Features Overview

Understanding Proxy Levels

• The discussion begins with the concept of proxies, specifically collection-level and global-level proxies. A global proxy affects all collections when enabled.

• Enabling a proxy allows access to values set at the collection level or through global settings, enhancing flexibility in managing requests.

Client Certificates and Local Server Setup

• Users can add client certificates (e.g., PFX, P12 formats) for secure connections. This is particularly useful for services like AWS or Azure.

• The setup includes options for path parameters and query patterns, allowing users to customize their requests effectively.

Request Management and Authentication

• When sending POST requests, users can specify headers and body content. Various authentication methods are supported, including API keys and bearer tokens.

• The context menu provides options to create new requests or folders within collections, facilitating organization.

Collection Management Features

Collection Operations

• Users can clone collections, rename them, share via URLs, or delete them as needed.

• Drag-and-drop functionality allows easy reordering of requests within a collection for better structure.

User Interface Overview

• The main screen presents an overview of documents and structures available in the application.

Modes of Operation in Bruno

Safe Mode vs Developer Mode

• Bruno operates in two modes: safe mode (for general use) and developer mode (for advanced features).

• Developer mode is necessary for certain libraries; it’s recommended to enable it during debugging sessions.

Collaboration Features in Bruno

Version Control Integration

• Collaboration features include creating branches and pushing changes using Git integration directly from the interface.

• Users can initialize repositories by adding origins (e.g., GitHub URLs), making collaboration seamless across teams.

Running Collections and Data Testing

• The collection runner feature allows execution of multiple requests with specified parameters for data testing.

• Users can utilize runtime variables alongside environment variables to manage different configurations efficiently.

Understanding Variable Scopes in Bruno

Overview of Variables

• Bruno allows users to create various types of variables, including process environment variables and request-level variables, enhancing automation and API testing capabilities.

• Users can set global variables that are accessible across multiple collections, providing flexibility in managing configurations.

Types of Variables

• Collection-level variables can be configured for specific collections, such as setting a base URL for the Swagger Pet Store collection.

• Environment-level variables are limited to their respective collections, ensuring that they do not interfere with other collections.

Executing Requests and Analyzing Responses

Request Execution

• Demonstration of executing a request using an echo server endpoint to illustrate how requests work within Bruno.

Response Analysis

• The response body includes key elements like ID and name data; users can view all request headers, response headers, and network logs for detailed analysis.

• Users can assert responses without writing extensive code by utilizing built-in functions available in Bruno.

Testing Features in Bruno

Built-in Testing Functions

• A variety of built-in functions (over 15 options available) allow users to perform quick assertions on response values without complex coding.

Custom Test Cases

• For more complex scenarios, users can write custom test scripts using the test tab where they define expected outcomes based on response status codes.

Product Walkthrough Summary

Comprehensive Feature Overview

• The walkthrough covers all features available in Bruno for new users looking to understand its functionalities thoroughly.

Open Source vs. Commercial Features

• While some features are part of a commercial product (G feature), most essential tools for API testing are available in the open-source version.

Resources and Documentation

Accessing Documentation

• Users are encouraged to explore the documentation for guidance on getting started with Bruno basics, creating collections, importing data from Postman collections, and understanding developer mode differences.