DEV Community: Luidy

Do Postman ao Bruno

Luidy — Wed, 30 Apr 2025 11:00:09 +0000

Originalmente lançado como uma extensão do Chrome em 2012, o Postman começou como um projeto paralelo de Abhinav Asthana. Ao longo dos anos, o Postman se tornou um companheiro inestimável para fazer requisições e testar APIs. Os arquivos de collection e ambiente do Postman foram compartilhados inúmeras vezes por desenvolvedores.

A collection do Postman foi projetada para ser um único arquivo contendo todas as requisições de API, scripts de pré-requisição, scripts de pós-requisição, scripts de teste, etc. Os arquivos de ambiente também desempenham um grande papel no ciclo de desenvolvimento, facilitando as trocas de ambiente.

No entanto, manter uma collection do Postman pode ser desafiador se houver uma quantidade substancial de APIs em equipes com mais de três membros. Um plano pago é necessário para obter colaboração ilimitada no Postman e manter a collection do Postman em sua cloud. Uma equipe que mantém cerca de cinquenta endpoints sob o plano gratuito teria dificuldades para manter a collection atualizada.

Devido à dificuldade de manter um grande arquivo de collection do Postman versionado no git, era hora de procurar alternativas. O recurso mais importante em um novo API Client seria ser amigável ao git e ter pelo menos as mesmas funcionalidades básicas que o Postman oferece, como scripts, configuração de ambiente, etc.

O Bruno API Client é um API Client relativamente novo que teve seu primeiro lançamento público em outubro de 2022. O que torna o Bruno único é sua estrutura de collection: em vez de ser apenas um único arquivo, ele é organizado como um projeto nodejs, com um arquivo principal cercado por vários arquivos de suporte. Cada requisição de API é salva como um arquivo com a extensão .bru. O Bruno é projetado pra ser developer friendly, facilitando a integração com o Git. Isso significa que você pode gerenciar suas collections do Bruno através de um repositório Git, o que realmente aumenta a colaboração entre os membros da equipe.

Você pode instalar o Bruno facilmente, seja baixando-o diretamente do site oficial ou usando um gerenciador de pacotes do sistema operacional, como homebrew, apt ou chocolatey.

A estrutura da collection do Bruno se assemelha a um projeto nodejs, tornando a collection colaborativa e fácil de manter.

Arquivos de Ambiente

No Bruno, os arquivos de ambiente estão associados a uma collection específica e são armazenados na pasta environments, com cada ambiente salvo em seu próprio arquivo separado. Ao contrário do Postman, onde os arquivos de ambiente podem ser compartilhados entre várias collections, os arquivos de ambiente do Bruno são dedicados a collections individuais, garantindo uma configuração mais organizada e focada.

O Bruno oferece uma variedade de variáveis de ambiente, incluindo global, environment, collection, folder, request, runtime e process variables. Além disso, ele suporta nativamente arquivos dotenv, permitindo que você armazene informações sensíveis de forma segura em sua máquina local, enquanto as mantém fora do controle de versão com gitignore. Isso torna o gerenciamento de seus dados sensíveis fácil e seguro!

Configuração do Arquivo Dotenv

Para começar, basta colocar um arquivo .env no diretório raiz da sua collection. Agora, vamos configurar uma API Key no arquivo .env!

API_KEY = fd79a328afe69b0

Você pode usar a variável API_KEY em suas requisições, bem como em arquivos de ambiente, referenciando-a assim:

{{process.env.API_KEY}}

Bibliotecas Externas

Como a collection do Bruno é estruturada como um projeto nodejs, instalar uma nova biblioteca é apenas um comando npm de distância. Usar uma biblioteca externa é necessário para habilitar o modo desenvolvedor. No entanto, isso exigiria adicionar à whitelist alguns módulos no arquivo bruno.json.

Cheerio é uma biblioteca para analisar respostas HTML que requer adicionar à whitelist algumas de suas dependências, como os módulos vm e buffer. Como mostrado abaixo:

"scripts": {
    "moduleWhitelist": [
      "vm",
      "buffer"
    ],
    "filesystemAccess": {
      "allow": false
    }
  }

Considerações Finais

O Bruno API Client é uma ferramenta valiosa para equipes que priorizam o gerenciamento de collections de API Client com uma abordagem voltada para o Git. Seus recursos e estrutura únicos tornam a colaboração mais fácil e eficiente, tornando-o uma ótima escolha para desenvolvedores.

From Postman to Bruno

Luidy — Wed, 30 Apr 2025 02:48:08 +0000

PT-BR Version

Originally launched as a Chrome extension in 2012, Postman started as a side project by Abhinav Asthana. Over the years, Postman has become an invaluable companion for making requests and testing APIs. Postman collection and environment files has been shared countless times by developers.

Postman collection was designed to be a single file containing all API requests, pre-request scripts, post-request scripts, test scripts, etc. Environment files also play a big role on development cycle making smoothly environment switches.

However, maintaining a Postman collection can be challenging if holds a substantially amount of APIs in teams with more than three members. A paid plan is required to get unlimited Postman collaboration to keep Postman collection in their cloud storage. A team maintaining about fifty endpoints under free plan would struggle to keep collection up to date.

Due to the distress maintaining a large Postman collection file versioned in git, it was time to look for alternatives. The most important feature in a new API Client would be git friendly and at least has same basic features Postman provides like scripts, environment configuration, etc.

Bruno API Client is a relatively new API client that had its first public release in October 2022. What makes Bruno unique is its collection structure: instead of being just a single file, it’s organized like a nodejs project, with a main file surrounded by several supporting files. Each API request is saved as a file with a .bru extension. Bruno is designed with developers in mind, making it easy to integrate with Git. This means you can manage your Bruno collections through a Git repository, which really boosts collaboration among team members.

You can easily install Bruno either by downloading it directly from the official website or by using a system package manager like Homebrew, apt, or Chocolatey.

Bruno collection structure looks like a nodejs project making a collection collaboratively and maintainable.

Environment Files

In Bruno, environment files are associated with a specific collection and are stored in the environments folder, with each environment saved in its own separate file. Unlike Postman, where environment files can be shared across multiple collections, Bruno's environment files are dedicated to individual collections, ensuring a more organized and focused setup.

Bruno offers a variety of environment variables, including global, environment, collection, folder, request, runtime, and process variables. Plus, it natively supports dotenv files, allowing you to store sensitive information securely on your local machine while keeping it out of version control with gitignore. This makes managing your sensitive data both easy and safe!

Dotenv File Configuration

To get started, simply place a .env file in the root directory of your collection. Now, let's configure an API key in the .env file!

API_KEY = fd79a328afe69b0

You can use the API_KEY variable in your requests as well as in environment files by referencing it like this:

{{process.env.API_KEY}}

External Libraries

Since Bruno collection is structured like a nodejs project, installing a new library is just a npm command away. Using an external library is required to enable developer mode. However, it would require to whitelist some modules in bruno.json file.

Cheerio is a library to parse html response that requires to whitelist some of its dependencies like vm and buffer modules. Like shown below:

"scripts": {
    "moduleWhitelist": [
      "vm",
      "buffer"
    ],
    "filesystemAccess": {
      "allow": false
    }
  }

Final Thoughts

Bruno API Client is a valuable tool for teams that prioritize managing API client collections with a Git-first approach. Its unique features and structure make collaboration easier and more efficient, making it a great choice for developers.