Automatizando testes pelo Postman

[lucas.ribeiro]

Olá Dev, você já se deparou com a necessidade de testar a API que está consumindo ou até mesmo sua própria API?

Trouxe para você uma solução prática, que possibilita testar a integridade de qualquer API, para isso iremos utilizar a ferramenta chamada Postman.

Mas porque testar?

Os testes confirmam que sua API está funcionando conforme o esperado, que as integrações entre os serviços estão funcionando de forma confiável e que quaisquer alterações não prejudicam a funcionalidade existente. Os scripts de testes para suas solicitações de API Postman podem ser escritos em JavaScript.

Você também pode usar o código de teste para auxiliar no processo de depuração quando algo der errado com seu projeto de API. 

O que é o Postman?

O Postman é uma ferramenta que dá suporte à documentação das requisições feitas pela API. Ele possui ambiente para a documentação, execução de testes de APIs e requisições em geral.

Vamos lá, primeiramente para iniciar os testes é necessário alguns passos.

• Instalar a ferramenta Postman clicando no link,
• Após instalada deverá configurar a requisição que desejar, e testar o retorno da API.
• Neste caso, iremos utilizar a API Plug Notas que nos retorna um JSON da nota fiscal consultada, mas você pode escolher a que desejar, caso queira conhecer o Plug Notas acesse o link.

Após configurada a consulta da API, você deverá testar o retorno obtido como abaixo.

O corpo da requisição nos retornou um Array com sucesso! Podemos dar prosseguimento.

Na aba Tests, ficaram todos os códigos JavaScript necessários para realizar os testes, vamos a alguns testes simples.

 

Verificando o status Code retornado.

Neste código utilizamos o “pm” biblioteca para executar o método "test”. A string de texto aparecerá na saída do teste, que basicamente é utilizado para dar nome ao teste, já a função dentro do teste representa uma afirmação.

Esse teste verifica o status code retornado pela API é igual a 200, se verdadeiro o teste será aprovado, caso contrário falhará.
 

Verificando se o Json retornado é um Array

Neste código armazenamos o JSON de resposta numa variável, e passamos essa variável como parâmetro para a função “expect” que seria esperar, então basicamente o teste espera que o JSON seja um Array Objects.

Obs: Use a sintaxe ChaiJS BDD e "pm.expect" em suas asserções para testar os detalhes da resposta.

 

Validando dados do Json

Neste código realizamos duas validações dentro de um mesmo teste, e para ter sucesso precisa retornar o esperado em ambas validações.

Primeiramente armazenamos o JSON de resposta numa variável, com essa variável podemos acessar os objetos do Array.

Realizamos uma busca por posições, no caso as propriedades idIntegracao e status no objeto posição 0 do Array jsonData, logo após passamos o valor esperado para os dois "expect", em caso de divergência na comparação com os valores retornados o teste retorna erro.
 

Curtiu Dev ? 

Caso tenha dúvidas pode acessar a documentação completa do Postman.

 

Fonte: https://learning.postman.com/docs/writing-scripts/script-references/test-examples/