Como usar scripts pós-solicitação no Postman?

Você provavelmente está familiarizado com Postman. Se você é um desenvolvedor ou testador de API, provavelmente já conhece o Postman. É uma ferramenta popular para testes de API, e possui muitos recursos que facilitam a simulação de requisições e a análise de respostas. Mas você sabia que também pode usar o Postman para automatizar tarefas e adicionar comportamentos dinâmicos às suas requisições? É aí que entram os scripts pós-requisição.

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

Scripts pós-requisição, também conhecidos como scripts de teste, são trechos de código JavaScript que o Postman executa após enviar uma requisição. Esses scripts são executados após o envio da requisição real e a recepção da resposta. Eles são usados para verificar se a API está funcionando corretamente, validar integrações e garantir que novos desenvolvimentos não afetaram a funcionalidade existente.

Enquanto os scripts pré-requisição preparam a requisição, os scripts pós-requisição analisam a resposta. Por exemplo, você pode verificar se os dados esperados estão presentes na resposta ou realizar verificações adicionais.

O que é o Postman

Postman é uma plataforma de desenvolvimento e teste de API que oferece uma variedade de recursos. Ela permite que desenvolvedores criem e compartilhem facilmente requisições e coleções de API, automatizem testes, simulem APIs e monitorem desempenho. O Postman também fornece ferramentas de colaboração e documentação, permitindo que equipes trabalhem juntas de forma mais eficiente e comuniquem o comportamento da API de forma eficaz.

Quando Usar Scripts Pós-Requisição?

Os scripts pós-requisição são extremamente versáteis, e você pode usá-los em muitos cenários diferentes. Os scripts pós-requisição são executados após a recepção da resposta. Eles são usados para verificar se a API está funcionando corretamente, checar integrações e garantir que novas mudanças não afetaram funcionalidades existentes. Você pode escrever scripts de teste em JavaScript para validar a resposta.

Como Usar Scripts Pós-Requisição?

1. Abra o Postman e Navegue até a aba “Tests” que está ao lado das abas “Headers” e “Body” na janela de requisição.

Escreva seus testes em JavaScript nesta aba. O Postman oferece um rico conjunto de trechos à direita para ajudá-lo a começar. Por exemplo, o comprimento dos elementos de dados deve ser maior que zero:

Escreva seus testes em JavaScript nesta aba. O Postman oferece um rico conjunto de trechos à direita para ajudá-lo a começar. Por exemplo, para verificar se o corpo da resposta contém uma determinada string, você pode usar:

// Verifique o comprimento dos elementos de dados
pm.test("O comprimento dos elementos de dados deve ser maior que zero", function () {
    const responseData = pm.response.json();
    
    pm.expect(responseData.data.id.length).to.be.greaterThan(0, "O ID não deve estar vazio");
    pm.expect(responseData.data.name.length).to.be.greaterThan(0, "O Nome não deve estar vazio");
    pm.expect(responseData.data.photoUrls.length).to.be.greaterThan(0, "PhotoUrls não deve estar vazio");
    pm.expect(responseData.data.category.id).to.be.greaterThan(0, "O ID da Categoria não deve estar vazio");
    pm.expect(responseData.data.category.name.length).to.be.greaterThan(0, "O nome da Categoria não deve estar vazio");
    responseData.data.tags.forEach((tag)=>{
        pm.expect(tag.id).to.be.greaterThan(0, "O ID da Tag não deve estar vazio");
        pm.expect(tag.name.length).to.be.greaterThan(0, "O nome da Tag não deve estar vazio");
    });
    pm.expect(responseData.data.status.length).to.be.greaterThan(0, "O Status não deve estar vazio");
});

Na aba “Resultados dos Testes” na parte inferior da seção de resposta. Se seu script passou, ele aparecerá em verde; se falhou, ficará em vermelho.

Use Post-Requisição em Scripts Apidog.

Apidog é um conjunto completo de ferramentas que conecta todo o ciclo de vida da API. Ele combina recursos de ferramentas como Postman, Swagger, Mock e JMeter. O Apidog ajuda equipes de P&D a implementar as melhores práticas para desenvolvimento com design de API em primeiro lugar. Sua interface amigável torna fácil projetar, depurar, documentar, simular e testar APIs.

Usar scripts pós-requisição no Apidog é uma ótima maneira de automatizar o teste das suas respostas de API. Aqui está um guia passo a passo de como usá-los:

Configure sua Requisição:

• No Apidog, crie uma nova requisição clicando no botão “+” ou selecionando “Nova API”.
• Insira a URL do recurso que você deseja atualizar (o endpoint onde você enviará sua requisição POST).
• Adicione qualquer cabeçalho ou parâmetro adicional que você precisa para sua requisição.

Escreva Scripts Pós-Requisição:

• Navegue até a aba “Processadores pós” ao lado das abas “Headers” e “Body” na janela de requisição.

// Verifique o comprimento dos elementos de dados
pm.test("O comprimento dos elementos de dados deve ser maior que zero", function () {
    const responseData = pm.response.json();
    
    pm.expect(responseData.data.id.length).to.be.greaterThan(0, "O ID não deve estar vazio");
    pm.expect(responseData.data.name.length).to.be.greaterThan(0, "O Nome não deve estar vazio");
    pm.expect(responseData.data.photoUrls.length).to.be.greaterThan(0, "PhotoUrls não deve estar vazio");
    pm.expect(responseData.data.category.id).to.be.greaterThan(0, "O ID da Categoria não deve estar vazio");
    pm.expect(responseData.data.category.name.length).to.be.greaterThan(0, "O nome da Categoria não deve estar vazio");
    responseData.data.tags.forEach((tag)=>{
        pm.expect(tag.id).to.be.greaterThan(0, "O ID da Tag não deve estar vazio");
        pm.expect(tag.name.length).to.be.greaterThan(0, "O nome da Tag não deve estar vazio");
    });
    pm.expect(responseData.data.status.length).to.be.greaterThan(0, "O Status não deve estar vazio");
});

Apidog permite que você adicione diferentes tipos de script de pós-requisição.

Envie a Requisição POST:

• Clique no botão “Enviar” para executar sua requisição POST.

Veja os resultados dos testes na aba à direita da seção de resposta. Se seu script passou, ele aparecerá em verde; se falhou, ficará em vermelho.

Scripts pós-requisição são particularmente úteis para:

• Validar a resposta: Garantir que a API retorna o código de status esperado, tempo de resposta e estrutura de dados.
• Definir variáveis de ambiente: Extrair dados da resposta e defini-los como uma variável de ambiente para uso em requisições subsequentes.
• Testes baseados em dados: Comparar a resposta com um conjunto de dados para validação.

Conclusão

Scripts pós-requisição são um recurso poderoso do Postman que pode ajudá-lo a automatizar tarefas, adicionar comportamentos dinâmicos às suas requisições e garantir que suas APIs estejam funcionando como esperado. Então, por que não experimentá-los? Você pode se surpreender com o quanto eles podem simplificar seu processo de teste de API.