Pular para o conteúdo
1337skills 1337skills - Folhas de Dicas

Comandos Bruno

Bruno é um cliente API leve, open-source e nativo do Git, projetado para testes e desenvolvimento de APIs. Diferentemente do Postman, Bruno armazena suas coleções como arquivos de texto simples (.bru) que podem ser versionados com Git, tornando-o ideal para colaboração em equipe e pipelines CI/CD.

Instalação

PlataformaComando
macOS (Homebrew)brew install bruno
Linux (Snap)snap install bruno
Linux (APT)sudo apt-get install bruno
Windows (Chocolatey)choco install bruno
npmnpm install -g @usebruno/cli
DownloadVisite usebruno.com/downloads

Começando

Iniciar Bruno GUI

bruno

Criar uma Nova Coleção

bruno create-collection my-api-collection

Abrir Coleção Existente

bruno /path/to/collection

Gerenciamento de Coleção

Estrutura da Coleção

Bruno armazena coleções como diretórios com arquivos .bru:

my-api-collection/
├── bruno.json          # Metadados da coleção
├── environments/
│   ├── Development.json
│   └── Production.json
├── auth/
│   └── auth.bru
└── users/
    ├── get-all-users.bru
    ├── create-user.bru
    └── update-user.bru

Importar do Postman

# Na GUI Bruno: Import → Selecione coleção JSON do Postman
# Ou use CLI (se disponível para sua versão do Bruno)

Organizar Requisições em Pastas

Crie pastas dentro de sua coleção para organizar requisições:

  • Clique com botão direito na árvore de coleção → Nova Pasta
  • Nomeie pastas logicamente (ex: users, products, auth)
  • Arraste requisições entre pastas

Exportar Coleção

# Coleções são armazenadas como arquivos simples (.bru)
# Simplesmente faça commit no Git ou compartilhe o diretório

Linguagem Bru (Formato de Requisição)

Bruno usa arquivos .bru—uma linguagem de marcação simples e legível para requisições.

Arquivo de Requisição Básica

meta {
  name: Get All Users
  type: http
  seq: 1
}

get {
  url: {{baseUrl}}/api/users
  auth: bearer
}

params:query {
  limit: 10
  offset: 0
}

headers {
  Content-Type: application/json
  User-Agent: Bruno/v1
}

auth:bearer {
  token: {{authToken}}
}

Requisição com Corpo

meta {
  name: Create User
  type: http
  seq: 2
}

post {
  url: {{baseUrl}}/api/users
}

headers {
  Content-Type: application/json
}

body:json {
  {
    "name": "John Doe",
    "email": "john@example.com",
    "role": "admin"
  }
}

Requisição de Dados de Formulário

meta {
  name: Upload Profile Picture
  type: http
  seq: 3
}

post {
  url: {{baseUrl}}/api/users/{{userId}}/avatar
}

body:form-urlencoded {
  username: johndoe
  email: john@example.com
}

Formulário Multipart (Upload de Arquivo)

meta {
  name: Upload File
  type: http
  seq: 4
}

post {
  url: {{baseUrl}}/api/files/upload
}

body:multipartForm {
  file: @/path/to/file.pdf
  description: My document
}

Comandos CLI

Executar Coleção ou Requisição

# Executar coleção inteira
bru run /path/to/collection

# Executar requisição específica
bru run /path/to/collection/requests/get-users.bru

# Executar com ambiente específico
bru run /path/to/collection --env Production

# Executar com formato de relatório JSON
bru run /path/to/collection --reporter json

# Executar com relatório HTML
bru run /path/to/collection --reporter html --output report.html

Relatórios Disponíveis

RelatórioComando
CLI (padrão)bru run collection --reporter cli
JSONbru run collection --reporter json
HTMLbru run collection --reporter html --output report.html
JUnitbru run collection --reporter junit

Executar com Variáveis

# Passar variáveis de ambiente
bru run /path/to/collection --env Development

# Substituir variável específica
bru run /path/to/collection --env Production --variable apiKey=abc123

Falhar em Erro

# Sair com status não-zero se algum teste falhar (útil para CI/CD)
bru run /path/to/collection --failOnError

Saída Verbosa

# Mostrar informações detalhadas de requisição/resposta
bru run /path/to/collection --verbose

Variáveis de Ambiente

Criar Arquivo de Ambiente

Arquivos de ambiente são armazenados como environments/EnvName.json:

{
  "baseUrl": "https://api.example.com",
  "apiKey": "your-api-key-here",
  "authToken": "bearer-token",
  "userId": "12345",
  "timeout": 5000
}

Usar Variáveis em Requisições

get {
  url: {{baseUrl}}/api/users/{{userId}}
  timeout: {{timeout}}
}

headers {
  Authorization: Bearer {{authToken}}
  X-API-Key: {{apiKey}}
}

Alternar Ambientes

# Via CLI
bru run /path/to/collection --env Development

# Via GUI: Selecione dropdown de ambiente na interface Bruno

Tipos de Variáveis de Ambiente

TipoExemploUso
String"apiKey": "abc123"{{apiKey}}
Number"timeout": 5000{{timeout}}
Boolean"debug": true{{debug}}
Object"config": {...}Acessar com scripting

Gerenciamento de Segredos

# Criar arquivo .env para dados sensíveis (adicione ao .gitignore)
echo "PROD_API_KEY=secret123" > .env

# Usar em arquivo de ambiente com referência
# Ou usar GUI Bruno para marcar campos como "Secret"

Scripts Pré-Requisição

Adicione JavaScript antes da requisição ser enviada:

// Definir valores dinâmicos
bru.setEnvVar('timestamp', Date.now());
bru.setEnvVar('nonce', Math.random().toString(36).substring(7));

// Lógica condicional
if (bru.getEnvVar('env') === 'production') {
  bru.setEnvVar('timeout', 10000);
}

// Log de informações de debug
console.log('Sending request to', bru.getEnvVar('baseUrl'));

Scripts Pós-Resposta

Execute JavaScript após receber a resposta:

// Acessar dados de resposta
const responseData = res.getBody();
const statusCode = res.getStatus();
const headers = res.getHeaders();

// Salvar valores para próxima requisição
if (statusCode === 200) {
  bru.setEnvVar('authToken', responseData.token);
  bru.setEnvVar('userId', responseData.user.id);
}

// Log de resposta
console.log('Status:', statusCode);
console.log('Response:', JSON.stringify(responseData, null, 2));

Operações Comuns de Resposta

// Obter código de status
const status = res.getStatus();

// Obter corpo como string
const body = res.getBody();

// Analisar corpo JSON
const data = res.getBody(true); // true = analisar como JSON

// Obter headers
const contentType = res.getHeader('content-type');

// Obter header específico
const authHeader = res.getHeader('authorization');

Asserções e Testes

Asserções Integradas de Teste

// Asserção de código de status
tests['Status is 200'] = (res.getStatus() === 200);

// Corpo de resposta contém
tests['Response contains user'] = res.getBody().includes('john');

// Validação de resposta JSON
const data = res.getBody(true);
tests['User ID exists'] = data.user && data.user.id > 0;

// Tempo de resposta
tests['Response time < 500ms'] = res.getResponseTime() < 500;

// Validação de header
tests['Content-Type is JSON'] = res.getHeader('content-type').includes('application/json');

Exemplo de Teste Complexo

const data = res.getBody(true);

tests['Status is 201'] = res.getStatus() === 201;
tests['ID is a number'] = typeof data.id === 'number';
tests['Email is valid'] = /^[\w-\.]+@([\w-]+\.)+[\w-]{2,4}$/.test(data.email);
tests['Created at is ISO date'] = !isNaN(Date.parse(data.createdAt));

// Salvar para próxima requisição
if (tests['Status is 201']) {
  bru.setEnvVar('newUserId', data.id);
}

Autenticação

Bearer Token

auth:bearer {
  token: {{authToken}}
}

Autenticação Básica

auth:basic {
  username: {{username}}
  password: {{password}}
}

Chave de API (Header)

headers {
  X-API-Key: {{apiKey}}
  Authorization: ApiKey {{apiKey}}
}

Chave de API (Parâmetro de Query)

params:query {
  api_key: {{apiKey}}
  apiToken: {{token}}
}

OAuth 2.0

auth:oauth2 {
  grant_type: authorization_code
  authorization_url: https://provider.com/oauth/authorize
  token_url: https://provider.com/oauth/token
  client_id: {{clientId}}
  client_secret: {{clientSecret}}
  scope: read write
}

Digest Auth

auth:digest {
  username: {{username}}
  password: {{password}}
}

Tipos de Requisição e Métodos

Requisição GET

meta {
  name: Fetch User
  type: http
  seq: 1
}

get {
  url: {{baseUrl}}/api/users/{{userId}}
}

params:query {
  includeProfile: true
  fields: id,name,email
}

Requisição POST

post {
  url: {{baseUrl}}/api/users
}

body:json {
  {
    "name": "Jane Doe",
    "email": "jane@example.com"
  }
}

Requisição PUT/PATCH

put {
  url: {{baseUrl}}/api/users/{{userId}}
}

body:json {
  {
    "name": "Jane Smith",
    "status": "active"
  }
}

Requisição DELETE

delete {
  url: {{baseUrl}}/api/users/{{userId}}
}

Requisição com Headers

headers {
  Content-Type: application/json
  Accept: application/json
  User-Agent: Bruno/v1.0
  X-Request-ID: {{requestId}}
  Authorization: Bearer {{token}}
}

Recursos Avançados

Variáveis no Nível de Coleção

Defina variáveis em bruno.json:

{
  "name": "My API Collection",
  "version": "1.0",
  "variables": {
    "baseUrl": "https://api.example.com",
    "version": "v1",
    "defaultTimeout": 5000
  }
}

Sequenciamento de Requisição

Controle a ordem de execução no executor CLI:

meta {
  name: Authenticate
  type: http
  seq: 1
}
meta {
  name: Get User Data
  type: http
  seq: 2
}

As requisições são executadas na ordem de seq.

Consultas GraphQL

meta {
  name: GraphQL Query
  type: http
  seq: 1
}

post {
  url: {{baseUrl}}/graphql
}

body:graphql {
  query {
    user(id: "{{userId}}") {
      id
      name
      email
    }
  }
}

Parâmetros de Query

params:query {
  page: 1
  limit: 10
  sort: -createdAt
  filter: status:active
}

Fluxo de Trabalho Git

Por que Git-Nativo É Importante

# Coleções armazenadas como arquivos de texto
.bru/
├── users/
│   ├── get-user.bru
│   └── create-user.bru
└── products/
    └── list-products.bru

# Fácil controle de versão
git add .
git commit -m "Update API requests"
git push origin main

# Conflitos de merge são gerenciáveis
# Revise mudanças em PRs
# Colabore com equipe

Fluxo de Trabalho de Colaboração

# Membro da equipe clona coleção
git clone https://github.com/team/api-collection.git
cd api-collection

# Instalar CLI Bruno
npm install -g @usebruno/cli

# Executar testes localmente
bru run . --env Development

# Fazer mudanças
# Adicionar novas requisições ou atualizar existentes

# Fazer commit e push
git add .
git commit -m "Add payment API endpoints"
git push origin feature/payments

Ignorar Arquivos Sensíveis

# .gitignore na raiz da coleção
.env
.env.local
environments/Production.json
!environments/Production.json.example
secrets/
node_modules/

Integração CI/CD

GitHub Actions

name: API Tests

on: [push, pull_request]

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3

      - name: Install Node.js
        uses: actions/setup-node@v3
        with:
          node-version: '18'

      - name: Install Bruno CLI
        run: npm install -g @usebruno/cli

      - name: Run API tests
        run: bru run . --env CI --reporter json --output test-results.json

      - name: Upload results
        if: always()
        uses: actions/upload-artifact@v3
        with:
          name: test-results
          path: test-results.json

GitLab CI

api-tests:
  image: node:18
  script:
    - npm install -g @usebruno/cli
    - bru run . --env CI --reporter json --output test-results.json
  artifacts:
    paths:
      - test-results.json
    reports:
      junit: test-results.json

Hook de Pré-commit Local

#!/bin/bash
# .git/hooks/pre-commit

echo "Running API tests..."
bru run . --env Development --failOnError

if [ $? -ne 0 ]; then
  echo "API tests failed. Commit aborted."
  exit 1
fi

Fluxos de Trabalho Comuns

Teste de API REST

# 1. Configurar ambiente
bru run /path/to/collection --env Development

# 2. Verificar resultados de testes
# Testes passam/falham exibidos na saída

# 3. Gerar relatório
bru run /path/to/collection --env Development --reporter html --output report.html

Teste de Carga com Requisições Paralelas

// Em script pré-requisição
for (let i = 0; i < 10; i++) {
  bru.setEnvVar('iteration', i);
}

Geração Dinâmica de Dados

// Gerar email único por requisição
const timestamp = Date.now();
bru.setEnvVar('dynamicEmail', `user_${timestamp}@example.com`);

// Gerar ID aleatório
bru.setEnvVar('randomId', Math.floor(Math.random() * 10000));

Encadeamento de Requisições

// Em script pós-resposta da primeira requisição
const data = res.getBody(true);
bru.setEnvVar('userId', data.id);
// Próxima requisição usa {{userId}}

Depuração

Ativar Modo Verboso

bru run /path/to/collection --verbose

Ver Detalhes de Requisição/Resposta

Na GUI Bruno:

  • Clique em requisição
  • Veja aba “Params” para parâmetros de query
  • Veja aba “Body” para corpo da requisição
  • Veja aba “Response” para dados de resposta
  • Veja aba “Tests” para resultados de testes

Log do Console

// Em scripts pré-requisição ou pós-resposta
console.log('Variable value:', bru.getEnvVar('baseUrl'));
console.log('Full response:', res.getBody());
console.log('Status code:', res.getStatus());

Inspeção de Rede

// Verificar headers de resposta
const headers = res.getHeaders();
console.log('All headers:', headers);

// Verificar tempo de resposta
console.log('Response time:', res.getResponseTime(), 'ms');

Melhores Práticas de Estrutura de Arquivo

api-collection/
├── README.md                 # Documentação
├── .gitignore               # Ignorar arquivos sensíveis
├── bruno.json               # Metadados da coleção
├── environments/            # Arquivos de ambiente
│   ├── Development.json
│   ├── Staging.json
│   └── Production.json
├── globals.json             # Variáveis globais
├── auth/
│   ├── login.bru
│   └── refresh-token.bru
├── users/
│   ├── get-all-users.bru
│   ├── get-user-by-id.bru
│   ├── create-user.bru
│   ├── update-user.bru
│   └── delete-user.bru
├── products/
│   ├── list-products.bru
│   └── get-product.bru
└── scripts/
    ├── test-runner.js
    └── helpers.js

Recursos

RecursoURL
Site Oficialusebruno.com
Repositório GitHubgithub.com/usebruno/bruno
Documentaçãodocs.usebruno.com
Downloadusebruno.com/downloads
Comunidade Discorddiscord.gg/usebruno
Especificação Linguagem Brugithub.com/usebruno/bru
Guia de Testes de APIdocs.usebruno.com/api-testing
Issues GitHubgithub.com/usebruno/bruno/issues

Dicas e Truques

  • Git Diff para Revisões: Como coleções são arquivos, use git diff para revisar mudanças de API antes de fazer merge
  • Templates de Ambiente: Crie arquivos .example.json para ambientes para compartilhar estrutura de configuração sem segredos
  • Scripts Reutilizáveis: Armazene scripts de teste comuns em arquivos .js separados e referencie-os
  • Escopo de Variável: Variáveis de coleção se aplicam globalmente; variáveis no nível de requisição as sobrescrevem
  • Performance: Use flag --failOnError em CI/CD para capturar falhas de teste cedo
  • Documentação: Adicione comentários em arquivos .bru usando sintaxe // comment
  • Versionamento: Inclua versão de API na variável de URL base para alternar facilmente entre versões