Postman: Gerando Relatórios de Teste de API

O Newman é uma ferramenta de linha de comando para execução de coleções de testes de API. Ele permite que você integre seus testes de API criados no Postman com pipelines de CI/CD e scripts de automação. Além disso, o Newman pode gerar relatórios detalhados para acompanhar o desempenho dos testes e identificar problemas.

Neste tutorial, exploraremos como utilizar o Newman para gerar relatórios sobre os testes de API realizados no Postman e gerar um relatório em HTML para que você possa apresentar os resultados dos seus testes de forma mais atraente.

Primeiro de tudo vamos precisar instalar duas coleções, o newman e o newman-reporter-htmlextra, rodando os seguintes comandos no seu terminal.

npm i -g newman
npm i -g newman-reporter-htmlextra

O newman permite que você rode seus testes no postman diretamente pelo terminal da sua máquina usando o seguinte comando (lembre-se que é necessário acessar a pasta onde o arquivo da sua coleção se encontra):

newman run minhaCollection.json

Como mostrado na própria linha de comando, você pode executar o newman exportando sua coleção pelo Postman, ou através de um link que torna seus testes bem mais dinâmicos já que não será necessário ficar exportando sua collection sempre que realizar alguma alteração.

Para gerar esse link temos que:

• Pegar a API Key do nosso postman
• Pegar a UID da collection que queremos testar
• Pegar a UID do environment que usaremos no nosso teste

Primeiro vamos gerar sua API Key, para isso acesse sua conta no postman, clique em na sua foto de perfil, depois em “View Profile” e em “Edit Profile”

Na barra lateral vá em “API keys” e clique em “Generate API Key”

Dê um nome para sua key.

Não esqueça de COPIAR sua key gerada, pois você não terá mais acesso a ela.

Com sua key gerada agora podemos pegar a UID da collection e da envirmont.
Acesse o postman e vá na sua collection, no canto direito clique no “i” para acessar as informações da coleção e então copie o “ID”.

O mesmo processo deve ser realizado acessando a enviroment que será utilizada.

Para rodar os testes no newman (não esqueça de substituir as informações com ID (UID) da collection, enviroment e a key gerada) digite o seguinte comando no seu terminal:

newman run https://api.getpostman.com/collections/$UID?apikey=$APIKEY –environment https://api.getpostman.com/environments/$UID?apikey=$APIKEY

Para o newman também gerar o relatório rode o comando:

newman run https://api.getpostman.com/collections/$UID?apikey=$APIKEY –e https://api.getpostman.com/environments/$UID?apikey=$APIKEY -r htmlextra

Uma pasta será criada (onde o seu terminal esta aberto) com o nome “newman” onde será gerado o relatório.