Como definir variáveis no script pós-requisição do Postman

Testes de API eficazes necessitam da gestão dinâmica de dados. Os scripts pós-requisição do Postman oferecem um mecanismo robusto para alcançar isso por meio de configurações de variáveis. Ao capturar e armazenar estrategicamente valores das respostas da API, os testadores podem aumentar a eficiência, a manutenibilidade e a confiabilidade dos testes.

Este artigo investiga as complexidades de utilizar as capacidades de script do Postman para definir variáveis. Ele fornecerá orientações abrangentes sobre o uso das funções pm.environment.set() e pm.globals.set() para criar e gerenciar variáveis dentro de diferentes escopos. Exemplos práticos ilustrarão como extrair dados das respostas da API e atribuí-los a variáveis para uso posterior em casos de teste.

O que são Scripts Pós-Requisição?

Scripts pós-requisição são trechos de código JavaScript que são executados após o Postman enviar uma requisição e receber uma resposta. Eles oferecem uma maneira poderosa de interagir com os dados da resposta, realizar asserções, extrair informações e manipular dados para requisições subsequentes.

Essencialmente, eles permitem automatizar várias tarefas de teste e manipulação de dados dentro do ambiente do Postman.

Guia Passo a Passo sobre Como Definir uma Variável no Script Pós-Requisição do Postman

Passo 1 - Acesse a Aba de Script Pós-Requisição:

Primeiro, abra a API ou requisição que você deseja editar e clique na aba Scripts. É aqui que você pode encontrar a seção Post-response.

Passo 2 - Extraia Dados da Resposta do Postman

Use os métodos pm.response.json() ou pm.response.text() para acessar o corpo da resposta da API como JSON ou texto, respectivamente.

Durante esta etapa, você também deve empregar quaisquer técnicas necessárias de manipulação de objetos ou strings em JavaScript para extrair os dados desejados.

Passo 3 - Defina a Variável

Você deve usar pm.environment.set(), pm.globals.set() ou pm.collectionVariables.set() para armazenar os dados extraídos em uma variável. A escolha depende do escopo desejado.

Exemplo de Definição de uma Variável no Script Pós-Requisição do Postman

pm.test("Definir uma variável", () => {
    const jsonData = pm.response.json();
    const token = jsonData.access_token;
    pm.environment.set("auth_token", token);
});

Este trecho de código extrai o access_token da resposta JSON e o armazena em uma variável de ambiente chamada auth_token.

Dicas Adicionais

• Tratamento de Erros: Implemente tratamento de erros para lidar graciosamente com formatos de resposta inesperados ou dados ausentes.
• Tipos de Dados: Garanta tipos de dados corretos para variáveis. Use o operador typeof para verificar.
• Uso de Variáveis: Acesse variáveis em requisições subsequentes usando chaves duplas: {{auth_token}}.
• Melhores Práticas: Considere usar nomes descritivos para variáveis e organizar seus scripts para melhor legibilidade.

Vantagens de Definir Variáveis em Scripts Pós-Requisição do Postman

Dados de Teste Dinâmicos

Dados em tempo real: Capture e armazene dados dinâmicos das respostas da API (por exemplo, IDs, tokens, timestamps) para uso imediato em requisições subsequentes.

Testes orientados a dados: Crie testes mais robustos usando dados reais do sistema em vez de valores estáticos.

Reutilização de Dados de Teste

Eficiência: Reutilize dados capturados em várias requisições dentro de uma coleção ou ambiente, reduzindo a entrada manual de dados e potenciais erros.

Correlação: Vincule requisições dependentes passando dados de uma resposta para outra, melhorando a precisão dos testes.

Manutenção de Testes

Flexibilidade: Modifique facilmente os valores das variáveis sem alterar vários corpos de requisição, tornando as atualizações de testes mais eficientes.

Centralização: Gerencie dados de teste em um local centralizado (variáveis de ambiente ou globais) para melhor organização.

Cenários de Teste Complexos

Manipulação de dados: Processe e transforme dados capturados antes de armazená-los como uma variável, possibilitando lógica de teste complexa.

Lógica condicional: Use variáveis em declarações condicionais para controlar o fluxo do teste com base nos dados da resposta.

Colaboração

Dados compartilhados: Compartilhe variáveis de ambiente ou globais entre os membros da equipe para manter dados de teste consistentes.

Gerenciamento de ambiente: Crie diferentes ambientes com valores de variável variados para diferentes cenários de teste.

Casos de Uso Comuns para Definir Variáveis em Scripts Pós-Requisição do Postman

Definir variáveis em scripts pós-requisição do Postman é uma técnica versátil com numerosas aplicações em testes de API. Aqui estão alguns casos de uso comuns:

• Gerenciamento de token de autenticação: Extraia tokens de acesso das respostas de autenticação e armazene-os para requisições subsequentes.
• Manipulação de dados dinâmicos: Capture e armazene dados dinâmicos como IDs de usuário, números de pedido ou IDs de sessão para correlação de dados de teste.
• Testes orientados a dados: Gere dados de teste dinamicamente e armazene-os em variáveis para testes iterativos.
• Tratamento de erros: Armazene mensagens ou códigos de erro para análise ou relatórios futuros.
• Testes de desempenho: Meça os tempos de resposta e os armazene para análise.
• Encadeamento de requisições: Passe dados de uma requisição para outra, criando fluxos de teste complexos.
• Gerenciamento de ambiente: Armazene valores de configuração específicos do ambiente, como URLs base ou chaves de API.
• Geração de dados de teste: Crie dados aleatórios ou sequenciais para casos de teste.
• Lógica personalizada: Implemente lógica personalizada com base nos dados da resposta, como execução condicional ou transformações de dados.

Apidog - Uma Ferramenta de Desenvolvimento de API Tudo-em-Um

Apidog é uma ferramenta abrangente de API que fornece aos usuários funcionalidades completas para todo o ciclo de vida da API. Ele se especializa em uma interface de usuário simples e intuitiva que promove uma abordagem de design primeiro para o desenvolvimento de APIs.

Crie Scripts de Pós-Processamento em Questão de Segundos

Com o Apidog, você pode implementar pós-processadores da maneira que desejar.

Você pode selecionar entre uma variedade de pós-processadores, como asserções, personalizados e até scripts públicos.

Importe outras APIs para o Apidog

O Apidog suporta vários tipos de arquivos de API, incluindo OpenAPI (ou Swagger), Postman e Insomnia. Desta forma, você pode importar projetos existentes para o ambiente de desenvolvimento elegante do Apidog para modificações adicionais!

Primeiro, abra a seção de Configurações em seu projeto e localize o botão Importar Dados encontrado sob Gerenciamento de Dados. Se você não conseguir encontrar o tipo de arquivo que deseja importar, não se preocupe! Basta arrastar e soltar o arquivo na parte inferior da tela.

Conclusão

Ao dominar a arte de definir variáveis nos scripts pós-requisição do Postman, você desbloqueou uma ferramenta poderosa para otimizar seu fluxo de trabalho de testes de API. A capacidade de capturar e armazenar dinamicamente dados das respostas capacita você a criar suítes de teste mais robustas, eficientes e manuteníveis. Através de uma consideração cuidadosa dos escopos das variáveis e técnicas eficazes de extração de dados, você pode aumentar significativamente suas capacidades de teste e acelerar os ciclos de desenvolvimento.

Lembre-se, a chave para o sucesso reside em entender o comportamento da sua API, planejar seus casos de teste estrategicamente e aproveitar todo o potencial das funcionalidades de script do Postman. Ao seguir as orientações fornecidas neste artigo, você estará bem equipado para aproveitar o poder das variáveis e elevar seus testes de API a novos patamares.