Usando variáveis

No Apidog, variáveis permitem que você salve e reutilize valores facilmente. Armazenar um valor como uma variável permite que você o acesse em vários ambientes, requisições, scripts e cenários de teste. Utilizar variáveis aumenta a produtividade e promove o trabalho em equipe entre colegas.

O que são variáveis?

Uma variável é uma representação simbólica de dados que permite que você recupere um valor sem inseri-lo manualmente sempre que ele for necessário. Isso é útil para reutilizar os mesmos valores em diferentes locais.

Exemplo:
Se você tiver o mesmo token em várias requisições e prever alterações, salve o token como uma variável chamada {{my_token}}. Use {{my_token}} no valor do parâmetro da requisição. Quando o token mudar, atualizar o valor da variável o atualiza em todos os lugares.

Variáveis podem ter efeito em valores de parâmetros, corpos, URLs ou cabeçalhos.

No módulo Tests do Apidog, variáveis podem ser usadas para passar dados entre requisições.

Escopos de variáveis

O Apidog oferece suporte a variáveis em vários escopos para se ajustar a diferentes requisitos de desenvolvimento, teste e colaboração.

Prioridade (da mais baixa para a mais alta): Global < Módulo < Ambiente < Dados < Local

Quando uma variável com o mesmo nome é definida em diferentes escopos, o valor do escopo mais restrito tem precedência.

Variáveis globais

Compartilhadas no projeto: Acessíveis em todo um projeto. Úteis para compartilhar dados entre endpoints (por exemplo, token de login).

Compartilhadas na equipe: Compartilhadas em toda a equipe entre diferentes projetos (por exemplo, um token compartilhado entre um projeto de login e um projeto financeiro).

NOTE

Permissões: Para gerenciar variáveis da equipe, você precisa de permissões de administrador da equipe. Acesse Team Resources > Variables.

Scripts: Você pode usar pm.globals.set para atualizar valores locais em scripts, mas não pode alterar nomes ou valores compartilhados.

Variáveis de módulo

Definidas dentro de um módulo. A importação de "Collection variables" do Postman é mapeada para variáveis de módulo.

Variáveis de ambiente

Vinculadas a ambientes específicos (Desenvolvimento, Teste, Produção). Somente as variáveis do ambiente ativo são efetivas.

Variáveis de dados

Originadas de arquivos CSV ou JSON externos em Cenários de teste ou CLI. Os valores não persistem após a execução.

Variáveis locais

Variáveis temporárias restritas a uma única requisição ou execução de cenário de teste. Desaparecem quando concluídas.

TIP

As variáveis no Apidog são armazenadas como strings. Ao salvar objetos ou arrays, use JSON.stringify() para armazená-los e JSON.parse() para recuperá-los.

Valores compartilhados e locais

Cada variável tem dois estados:

Valor compartilhado: Sincronizado com os servidores do Apidog e compartilhado com a equipe.

Valor local: Armazenado LOCALMENTE no cache do seu navegador ou cliente. Não é compartilhado.

Práticas recomendadas:

Use Valor local para dados sensíveis (tokens, senhas), para que permaneçam em sua máquina.

Deixe o Valor local vazio para recorrer ao Valor compartilhado.

Clique no ícone de link 🔗 para sincronizar o Valor local com o Valor compartilhado.

WARNING

Limpar o cache do Apidog excluirá os Valores locais.

Valores locais NÃO migram automaticamente ao trocar de dispositivo (use Exportação/Importação de ambiente).

Usando variáveis na CLI do Apidog

Ao executar na CLI, o Valor compartilhado é usado por padrão, enquanto o Cliente usa o Valor local. Essa é uma causa comum de discrepâncias entre execuções no Cliente e na CLI.

TIP

Saiba mais sobre a CLI do Apidog.

Definindo variáveis

1. Gerenciamento de ambiente (predefinição)

Valores para variáveis globais e de ambiente podem ser predefinidos manualmente.

Clique no ícone Environment Management ≡.

Selecione Global Variables ou um ambiente específico.

Adicione o nome da variável, o valor compartilhado e o valor local.

Clique em Save.

2. Extrair variáveis

Extraia visualmente valores de respostas de API para variáveis sem escrever código.

Na aba Run (Modo Design), acesse Post Processors.

Selecione Extract Variable.

Configure a origem da extração (JSON, XML, Cabeçalho etc.) e o JSONPath.

Envie a requisição para executar e verifique no Console.

TIP

Saiba mais sobre Extract Variable.

3. Scripts

Use o objeto pm em pré/pós-processadores.

Sintaxe para set:

Armazenando objetos/arrays:

TIP

Saiba mais sobre Sintaxe de scripts.

4. Operações de banco de dados

Conecte-se a um banco de dados para recuperar dados e defini-los como uma variável.

Adicione Database Operation em Pós-processadores.

Configure a conexão com o banco de dados.

Insira o comando SQL (oferece suporte a {{variable}}).

Defina Extract Result To Variable.

TIP

Saiba mais sobre Operações de banco de dados.

Parâmetros da requisição

Use chaves duplas {{variable}} na URL, nos parâmetros, nos cabeçalhos ou no corpo.

Exemplo de URL:
http://127.0.0.1/pet/findByStatus?status={{CurrentStatus}}

Exemplo de corpo JSON:

{
    "status": "{{CurrentStatus}}",
    "quantity": {{TotalPet}}
}

WARNING

Strings: Adicione aspas duplas "" ao redor da variável para strings (por exemplo, "{{name}}").

Números/booleanos: NÃO adicione aspas (por exemplo, {{count}}).

Acessando subelementos

Se uma variável contiver um objeto/array JSON, acesse as propriedades por meio de notação de ponto usando JSONPath.

Objeto em {{user}}:

{ "id": 1, "name": "Jack" }

Requisição: {{user.name}}

Script: pm.variables.get("user.name")

Array em {{users}}:

[ { "name": "Jack" } ]

Requisição: {{users[0].name}}

Script: pm.variables.get("users[0].name")

Usando variáveis em scripts

Em scripts, use pm.*.get() em vez de {{}}.

Registro em log:

Verifique a aba Console para ver a saída.

Usando variáveis de dados

Em Cenários de teste, importar um arquivo CSV/JSON cria "Variáveis de dados". Use {{column_name}} para referenciá-las. Cada linha no arquivo aciona uma iteração separada.

TIP

Saiba mais sobre Teste orientado por dados.

Perguntas frequentes

P: Posso usar variáveis em Mocks?

Não. Variáveis são resolvidas quando uma requisição é enviada. Mocks são definições estáticas ou são executados no servidor de mock sem um contexto de "envio" do lado do cliente da mesma forma.

P: Como obtenho a URL base em um script?

Use pm.request.getBaseUrl().

Evite pm.environment.get('BASE_URL'), pois ele pode ser impreciso para endpoints de servidor não padrão.

Usando variáveis

O que são variáveis?#

Escopos de variáveis#

Valores compartilhados e locais#

Usando variáveis na CLI do Apidog#

Definindo variáveis#

1. Gerenciamento de ambiente (predefinição)#

2. Extrair variáveis#

3. Scripts#

4. Operações de banco de dados#

Usando variáveis#

Parâmetros da requisição#

Acessando subelementos#

Usando variáveis em scripts#

Usando variáveis de dados#

Perguntas frequentes#

O que são variáveis?

Escopos de variáveis

Valores compartilhados e locais

Usando variáveis na CLI do Apidog

Definindo variáveis

1. Gerenciamento de ambiente (predefinição)

2. Extrair variáveis

3. Scripts

4. Operações de banco de dados

Usando variáveis

Parâmetros da requisição

Acessando subelementos

Usando variáveis em scripts

Usando variáveis de dados

Perguntas frequentes