[Guia] Scripts de Requisições Post do Postman

Postman é uma ferramenta popular para desenvolvimento e teste de interfaces de programação de aplicações (API). Ela simplifica o processo de envio de requisições e análise de respostas, permitindo que os desenvolvedores construam e depurem APIs de forma eficiente. A programação no Postman amplia essas funcionalidades, permitindo a automação de tarefas repetitivas dentro do fluxo de trabalho de testes.

Este artigo explora como criar scripts de Post Request no Postman, guiando você pelo processo de envio de dados, manipulação de respostas e, por fim, melhorando a eficiência e a abrangência dos testes de sua API.

O que são Scripts de Post-Request do Postman

Os scripts de post-request do Postman são essencialmente pequenos programas escritos em JavaScript que executam após o Postman enviar uma requisição e receber uma resposta de uma API.

É uma ferramenta essencial para desenvolvedores que trabalham com APIs (Interfaces de Programação de Aplicações). Ela simplifica o envio de requisições, análise de respostas e, por fim, construção e depuração de APIs.

Funções Principais dos Scripts de Post-Request do Postman

Validação de Resposta

Verificação do Código de Status: Scripts podem verificar se a API responde com o código de status esperado (por exemplo, 200 para sucesso). Isso garante que a API está funcionando conforme o esperado.

Aserções de Dados: Você pode escrever asserções para validar o conteúdo do corpo da resposta. Scripts podem verificar valores específicos e estruturas de dados (como objetos JSON com certas chaves), ou garantir a ausência de dados inesperados.

Manipulação de Dados

Transformando Dados de Resposta: Scripts podem processar dados recebidos na resposta. Isso pode envolver formatação de datas, conversão de unidades ou extração de peças específicas de informação para uso posterior.

Preparando Dados para Requisições Subsequentes: Com base na resposta recebida, scripts podem modificar dados enviados em requisições subsequentes. Isso permite cenários de teste dinâmicos e interações encadeadas com a API.

Integração com Ferramentas Externas

Enviando Notificações: Scripts podem disparar notificações com base nos resultados dos testes. Imagine enviar uma mensagem ao Slack se um teste crítico de API falhar.

Registro de Resultados: A programação permite registrar os resultados dos testes em bancos de dados externos para análise ou fins de relatório.

Ambiente de Scripting e Objetos

Execução de JavaScript: O Postman fornece um ambiente "Sandbox" onde seus scripts são executados de forma segura.

Acessando Dados de Requisição e Resposta: O objeto pm fornece acesso a várias propriedades, com foco em pm.response para interagir com os dados de resposta (corpo, cabeçalhos, etc.).

Casos de Uso Comuns para Scripts de Post-Request do Postman

Validação Abrangente de Respostas

Verificando Códigos de Status: Scripts podem garantir que a API responde com o código de status esperado para sucesso (200), erros (400, 404) ou outros códigos relevantes.

Aserções de Dados Detalhadas: Vá além de verificações simples. Scripts podem validar estruturas complexas de dados dentro do corpo da resposta. Você pode afirmar a presença ou ausência de chaves específicas em um objeto JSON, verificar o formato de dados (por exemplo, datas, endereços de e-mail) ou garantir que valores específicos existam nas estruturas aninhadas.

Extraindo Dados para Uso Posterior: Scripts podem extrair informações valiosas do corpo da resposta. Esses dados podem ser usados em requisições subsequentes, armazenados para análise posterior ou passados para outras ferramentas para processamento adicional.

Manipulação Avançada de Dados

Transformando Dados de Resposta: Scripts podem modificar os dados recebidos na resposta para atender às suas necessidades de teste. Isso pode envolver formatação de timestamps, conversão de moedas ou manipulação de tipos de dados (por exemplo, conversão de strings em números).

Preparando Requisições Dinâmicas: Com base na resposta de uma chamada de API, scripts podem modificar dinamicamente dados enviados em requisições subsequentes. Isso permite cenários de teste que se baseiam uns nos outros, simulando interações reais com a API.

Gerando Dados de Teste: Scripts podem gerar dinamicamente dados de teste para chamadas de API. Isso pode ser útil para testar casos extremos, criando grandes conjuntos de dados ou randomizando dados para vários cenários.

Integração com Ferramentas Externas para Testes Aprimorados

Enviando Notificações: Imagine receber uma notificação instantânea no Slack sempre que um teste crítico de API falhar. Scripts podem acionar notificações com base nos resultados dos testes, mantendo sua equipe informada sobre possíveis problemas.

Registro de Resultados de Teste: Scripts podem ser usados para registrar resultados detalhados de testes em bancos de dados externos. Isso permite relatórios abrangentes, análise histórica do desempenho dos testes e identificação de tendências ao longo do tempo.

Integração com Frameworks de Teste: Scripts podem conectar o Postman com frameworks de teste externos como Jest ou Mocha. Isso permite que você aproveite ferramentas de teste existentes dentro do seu fluxo de trabalho do Postman para uma abordagem de teste mais holística.

Exemplos de Scripts de Post-Request do Postman

Acessando o Código de Status da Resposta e Dados do Corpo

pm.test("O código de status é 200", function () {
  pm.response.to.have.status(200);
});

console.log(pm.response.json());

Este script realiza duas ações:

• Ele usa pm.test para verificar se o código de status da resposta é 200 (indicando sucesso).
• Ele utiliza pm.response.json() para imprimir todo o conteúdo do corpo da resposta no console para inspeção.

Construindo Aserções com pm.test

A função pm.test do Postman permite que você escreva asserções mais robustas sobre os dados da resposta. Aqui estão alguns exemplos:

Verificando Valores Específicos

pm.test("O nome existe na resposta", function () {
  pm.expect(pm.response.json().name).to.equal("John Doe");
});

Validando Estrutura de Dados

pm.test("A resposta tem a estrutura esperada", function () {
  pm.expect(pm.response.json()).to.have.property("id");
  pm.expect(pm.response.json()).to.have.property("name");
});

Apidog - Uma Ferramenta Completa de Desenvolvimento de API

Apidog é uma ferramenta abrangente de API que fornece aos usuários funcionalidades completas para todo o ciclo de vida da API. Você não precisa mais baixar aplicativos adicionais!

Aplique Seus Próprios Scripts de Pós-Processamento com Apidog

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, scripts personalizados e até mesmo scripts públicos.

Teste Múltiplas APIs com Cenários de Teste

Apidog possui uma funcionalidade única de teste chamada cenários de teste.

Com o Apidog, você pode testar visualmente diferentes APIs juntas em uma série de etapas consecutivas. Isso é especialmente eficaz para desenvolvedores que criaram uma cadeia de APIs que dependem umas das outras para executar suas funcionalidades.

APIs Perfeitas com Relatórios Acurados e Detalhados

O Apidog retornará então um relatório detalhado sobre seu cenário de teste, detalhando o número de requisições falhas e bem-sucedidas, juntamente com a duração total de todas as APIs para completá-las.

Conclusão

Os scripts de post-request do Postman oferecem uma ferramenta poderosa e versátil para aprimorar seu processo de teste de API. Ao usar esses scripts, você pode automatizar tarefas repetitivas, realizar validações abrangentes de dados e integrar-se a ferramentas externas para um fluxo de trabalho mais simplificado. Se você é um desenvolvedor experiente ou está apenas começando com testes de API, as capacidades de scripting do Postman permitem que você construa APIs robustas e confiáveis com maior eficiência.

Lembre-se, o mundo da programação no Postman oferece um vasto potencial de exploração. Comece com os fundamentos aqui apresentados e mergulhe mais profundamente para desbloquear todo o potencial dessa ferramenta valiosa para sua jornada de desenvolvimento de API.