[Guia] Scripts de Requisição Post do Postman

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

Este artigo explora como criar scripts de solicitação POST no Postman, guiando você pelo processo de envio de dados, manipulação de respostas e, por fim, melhorando a eficiência e minuciosidade de seus testes de API.

O que são scripts de solicitação POST do Postman

Os scripts de solicitação POST do Postman são essencialmente pequenos programas escritos em JavaScript que são executados após o Postman enviar uma solicitação e receber uma resposta de uma API.

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

Funções principais dos scripts de solicitação POST do Postman

Validação de resposta

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

Aserções de Dados: Você pode escrever asserções para validar o conteúdo do corpo da resposta. Os 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 da Resposta: Os 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 Solicitações Subsequentes: Com base na resposta recebida, os scripts podem modificar os dados enviados em solicitações subsequentes. Isso permite cenários de teste dinâmicos e interações encadeadas com a API.

Integração com Ferramentas Externas

Envio de Notificações: Os scripts podem disparar notificações com base nos resultados dos testes. Imagine enviar uma mensagem para o Slack se um teste crítico de API falhar.

Registro de Resultados: A scriptização permite registrar os resultados dos testes em bancos de dados externos para análises ou relatórios posteriores.

Ambiente de Scriptização e Objetos

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

Acessando Dados de Solicitaçã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 Solicitação POST do Postman

Validação Abrangente de Resposta

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

Aserções Detalhadas de Dados: Vá além de verificações simples. Os scripts podem validar estruturas de dados complexas 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 dos dados (por exemplo, datas, endereços de e-mail) ou garantir que valores específicos existam dentro de estruturas aninhadas.

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

Manipulação Avançada de Dados

Transformando Dados da Resposta: Os 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, convertendo strings em números).

Preparando Solicitações Dinâmicas: Com base na resposta de uma chamada de API, os scripts podem modificar dinamicamente os dados enviados em solicitações subsequentes. Isso permite cenários de teste que se baseiam uns nos outros, simulando interações de API do mundo real.

Gerando Dados de Teste: Os scripts podem gerar dados de teste dinamicamente 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

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

Registro de Resultados de Teste: Os 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: Os scripts podem conectar o Postman com frameworks externos de teste 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 Solicitação POST 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:

• Utiliza pm.test para afirmar que o código de status da resposta é 200 (indicando sucesso).
• Utiliza pm.response.json() para imprimir o conteúdo completo 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 de resposta. Aqui estão alguns exemplos:

Verificando Valores Específicos

pm.test("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 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. Você não precisa mais baixar aplicativos adicionais!

Aplique seus próprios scripts de pós-processamento com Apidog

Com Apidog, você pode implementar post-processadores da maneira que desejar.

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

Teste Múltiplas APIs com Cenários de Teste

Apidog tem um recurso de teste único chamado cenários de teste.

Com 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 Precisos e Detalhados

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

Conclusão

Os scripts de solicitação POST do Postman oferecem uma ferramenta poderosa e versátil para aprimorar seu processo de teste de API. Ao aproveitar esses scripts, você pode automatizar tarefas repetitivas, realizar validações de dados abrangentes e integrar ferramentas externas para um fluxo de trabalho mais simplificado. Seja você um desenvolvedor experiente ou apenas começando com testes de API, as capacidades de scriptização do Postman capacitam você a construir APIs robustas e confiáveis com maior eficiência.

Lembre-se, o mundo da scriptização no Postman oferece um vasto potencial para exploração. Comece com os conceitos básicos aqui descritos e aprofunde-se para desbloquear todo o potencial desta ferramenta valiosa para sua jornada de desenvolvimento de API.