Utilizar Variáveis

No Apidog, as variáveis permitem-lhe guardar e reutilizar valores facilmente. Armazenar um valor como variável permite-lhe aceder-lhe em vários ambientes, pedidos, scripts e cenários de teste. A utilização de variáveis aumenta a produtividade e promove o trabalho em equipa entre colegas.

O que são Variáveis?

Uma variável é uma representação simbólica de dados que lhe permite obter um valor sem o introduzir manualmente sempre que for necessário. Isto é útil para reutilizar os mesmos valores em diferentes locais.

Exemplo:
Se tiver o mesmo token em vários pedidos e antecipar alterações, guarde o token como uma variável denominada {{my_token}}. Utilize {{my_token}} no valor do parâmetro do pedido. Quando o token mudar, atualizar o valor da variável atualiza-o em todos os locais.

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

No módulo Testes do Apidog, as variáveis podem ser utilizadas para passar dados entre pedidos.

Âmbitos das Variáveis

O Apidog suporta variáveis em vários âmbitos para se adaptar 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 âmbitos, o valor do âmbito mais restrito tem precedência.

Variáveis Globais

Partilhadas no Projeto: Acessíveis em todo um projeto. Úteis para partilhar dados entre endpoints (por exemplo, token de início de sessão).

Partilhadas na Equipa: Partilhadas em toda a equipa, em diferentes projetos (por exemplo, um token partilhado entre um projeto de início de sessão e um projeto financeiro).

NOTE

Permissões: Para gerir variáveis da equipa, precisa de permissões de administrador da equipa. Aceda a Recursos da Equipa > Variáveis.

Scripts: Pode utilizar pm.globals.set para atualizar valores locais em scripts, mas não pode alterar nomes ou valores partilhados.

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

Associadas a ambientes específicos (Desenvolvimento, Teste, Produção). Apenas as variáveis do ambiente ativo têm efeito.

Variáveis de Dados

Provenientes de ficheiros CSV ou JSON externos em Cenários de Teste ou na CLI. Os valores não persistem após a execução.

Variáveis Locais

Variáveis temporárias confinadas a um único pedido ou execução de cenário de teste. Desaparecem quando a execução termina.

TIP

As variáveis no Apidog são armazenadas como strings. Ao guardar objetos ou arrays, utilize JSON.stringify() para armazenar e JSON.parse() para os obter.

Valores Partilhados e Locais

Cada variável tem dois estados:

Valor Partilhado: Sincronizado com os servidores do Apidog e partilhado com a equipa.

Valor Local: Armazenado LOCALMENTE na cache do seu navegador ou cliente. Não é partilhado.

Boas Práticas:

Utilize o Valor Local para dados sensíveis (tokens, palavras-passe), para que permaneçam na sua máquina.

Deixe o Valor Local vazio para recorrer ao Valor Partilhado.

Clique no ícone de ligação 🔗 para sincronizar o Valor Local com o Valor Partilhado.

WARNING

Limpar a cache do Apidog eliminará os Valores Locais.

Os Valores Locais NÃO migram automaticamente ao trocar de dispositivo (utilize a Exportação/Importação de Ambiente).

Utilizar Variáveis na CLI do Apidog

Ao executar na CLI, o Valor Partilhado é utilizado por predefinição, enquanto o Cliente utiliza o Valor Local. Esta é uma causa comum de discrepâncias entre execuções no Cliente e na CLI.

TIP

Saiba mais sobre a CLI do Apidog.

Definir Variáveis

1. Gestão de Ambientes (Predefinição)

Os valores das variáveis Globais e de Ambiente podem ser predefinidos manualmente.

Clique no ícone Gestão de Ambientes ≡.

Selecione Variáveis Globais ou um ambiente específico.

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

Clique em Guardar.

2. Extrair Variáveis

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

No separador Executar (Modo de Design), aceda a Pós-processadores.

Selecione Extrair Variável.

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

Envie o pedido para executar e verifique na Consola.

TIP

Saiba mais sobre Extrair Variável.

3. Scripts

Utilize o objeto pm em Pré/Pós-processadores.

Sintaxe de set:

Armazenar Objetos/Arrays:

TIP

Saiba mais sobre a Sintaxe de Scripts.

4. Operações de Base de Dados

Ligue-se a uma base de dados para obter dados e defini-los como uma variável.

Adicione Operação de Base de Dados em Pós-processadores.

Configure a ligação à base de dados.

Introduza o comando SQL (suporta {{variable}}).

Defina Extrair Resultado para Variável.

TIP

Saiba mais sobre Operações de Base de Dados.

Parâmetros do Pedido

Utilize chavetas duplas {{variable}} no URL, parâmetros, cabeçalhos ou 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 "" em torno da variável para strings (por exemplo, "{{name}}").

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

Aceder a Subelementos

Se uma variável contiver um objeto/array JSON, aceda às propriedades através de notação por pontos utilizando JSONPath.

Objeto em {{user}}:

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

Pedido: {{user.name}}

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

Array em {{users}}:

[ { "name": "Jack" } ]

Pedido: {{users[0].name}}

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

Utilizar Variáveis em Scripts

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

Registo:

Consulte o separador Consola para ver a saída.

Utilizar Variáveis de Dados

Em Cenários de Teste, importar um ficheiro CSV/JSON cria "Variáveis de Dados". Utilize {{column_name}} para as referenciar. Cada linha no ficheiro aciona uma iteração separada.

TIP

Saiba mais sobre Testes Orientados por Dados.

FAQ

P: Posso utilizar variáveis em Mocks?

Não. As variáveis são resolvidas quando um pedido é enviado. Os mocks são definições estáticas ou são executados no servidor mock sem um contexto de "envio" do lado do cliente da mesma forma.

P: Como obtenho o URL base num script?

Utilize pm.request.getBaseUrl().

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

Utilizar Variáveis

O que são Variáveis?#

Âmbitos das Variáveis#

Valores Partilhados e Locais#

Utilizar Variáveis na CLI do Apidog#

Definir Variáveis#

1. Gestão de Ambientes (Predefinição)#

2. Extrair Variáveis#

3. Scripts#

4. Operações de Base de Dados#

Utilizar Variáveis#

Parâmetros do Pedido#

Aceder a Subelementos#

Utilizar Variáveis em Scripts#

Utilizar Variáveis de Dados#

FAQ#

O que são Variáveis?

Âmbitos das Variáveis

Valores Partilhados e Locais

Utilizar Variáveis na CLI do Apidog

Definir Variáveis

1. Gestão de Ambientes (Predefinição)

2. Extrair Variáveis

3. Scripts

4. Operações de Base de Dados

Utilizar Variáveis

Parâmetros do Pedido

Aceder a Subelementos

Utilizar Variáveis em Scripts

Utilizar Variáveis de Dados

FAQ