Como desenvolvedor de API, você provavelmente está familiarizado com o Postman, uma ferramenta popular para testar e automatizar requisições de API. O Postman Newman tem sido uma ferramenta de referência para muitos desenvolvedores por anos, mas não está sem suas limitações.
Neste guia, vamos abordar a instalação e o uso do Newman, uma ferramenta de linha de comando projetada para executar coleções do Postman. Seguindo este guia, você aprenderá a instalar o Newman e a executar coleções do Postman, permitindo automatizar seu processo de teste de API. Recomendo o Apidog como uma alternativa poderosa.
O que é o Newman no Postman
O Newman Postman é uma ferramenta de linha de comando que permite que os desenvolvedores executem coleções e ambientes do Postman em um ambiente de integração contínua (CI). Postman é uma ferramenta popular de desenvolvimento de API que permite que os desenvolvedores projetem, testem e documentem APIs. O Newman, por outro lado, é uma ferramenta que permite que os desenvolvedores automatizem testes de API usando coleções e ambientes do Postman.
Com o Newman Postman, os desenvolvedores podem facilmente automatizar testes de API e garantir que suas APIs estejam funcionando como esperado. O Newman suporta uma variedade de integrações e plugins, tornando-o uma ferramenta versátil para o desenvolvimento de APIs. No entanto, há algumas limitações no Newman Postman que os desenvolvedores devem estar cientes, como sua complexidade para configurar, execução de testes lenta, e custo para uso em larga escala.
Qual é a Diferença entre Newman e Postman
O Postman e o Newman são ambas ferramentas de desenvolvimento de API, mas servem a propósitos diferentes. O Postman é um aplicativo de desktop que permite que os desenvolvedores testem APIs com uma interface gráfica (GUI). O Newman, por outro lado, é uma ferramenta de linha de comando que permite que os desenvolvedores executem coleções e ambientes do Postman em um ambiente de integração contínua (CI), facilitando a automação de testes de API.
Outra diferença entre o Postman e o Newman é seu custo. O Postman tem uma versão gratuita, mas também oferece planos pagos com recursos adicionais. O Newman, por outro lado, é uma ferramenta de código aberto que é gratuita para uso.
Como Executar Coleção Postman no Newman？
Instalando o Newman
O Newman é construído sobre o Node.js. Para executar o Newman, certifique-se de que você tenha o Node.js instalado. E Node.js >= v10. Você pode instalar o Node.js com o gerenciador de pacotes: https://nodejs.org/en/download/package-manager
Usar o NPM é uma maneira comum e fácil de instalar o Newman. Digite o seguinte comando no terminal.
$ npm install -g newman
Usando a flag "-g", o Newman será instalado globalmente em seu sistema, permitindo que você o execute de qualquer local.
Executando o Newman
Você pode usar o comando "newman run" para indicar qual coleção executar. É simples exportar sua Coleção Postman como um arquivo JSON do aplicativo Postman e depois executá-la usando o Newman.
$ newman run mycollection.json
Recomendado para Ler:
Dicas Extras do Postman Newman
Usando o Newman com CI/CD
O Newman sai com um código de status de 0 por padrão se tudo correr bem, sem exceções. Para garantir que suas ferramentas de integração contínua (CI) respondam aos códigos de saída do Newman e passem ou falhem em uma construção de acordo, você pode configurá-los adequadamente.
Adicionalmente, você pode usar a flag "--bail" para fazer o Newman parar a execução se encontrar um erro de caso de teste com um código de status de 1. Este erro pode então ser capturado pela sua ferramenta de CI ou sistema de construção e agido de acordo.
Usando o Newman como uma biblioteca Node.js
O Newman também pode ser usado como uma biblioteca Node.js, permitindo que os desenvolvedores integrem testes de API em suas aplicações Node.js. Usando o Newman como uma biblioteca, os desenvolvedores podem executar coleções programaticamente, acessar resultados de testes e integrar testes em seu processo de construção.
const newman = require('newman'); // Importa o módulo Newman
async function runCollection() {
try {
await newman.run({
collection: require('./sample-collection.json'),
reporters: 'cli'
});
console.log('Execução da coleção completa!');
} catch (err) {
console.error(err);
}
}
runCollection();
Este código de exemplo usa a sintaxe async/await para tornar a execução do Newman mais concisa e legível. Ele importa o módulo Newman e define uma função assíncrona chamada runCollection para executar a coleção. Dentro da função, usa a palavra-chave await para esperar o Newman terminar de executar, e então imprime uma mensagem indicando que a coleção foi executada. Se um erro ocorrer, ele captura e imprime o erro. Finalmente, chama a função runCollection() para executar todo o programa.
Alternativa ao Postman Newman: Apidog
O Apidog fornece suporte para exportar casos de teste para formatos Apidog CLI, Postman e JMeter, facilitando a integração de testes de API em seu processo de integração contínua.
O Apidog CLI é projetado especificamente para executar casos de teste do Apidog na linha de comando, fornecendo uma maneira simplificada de executar testes e automatizar o processo de teste. Ao exportar casos de teste para o Apidog CLI, os desenvolvedores podem facilmente integrar testes de API em seus processos de construção e garantir que as APIs sejam testadas de forma abrangente e consistente.
Além do Apidog CLI, o Apidog também suporta a exportação de casos de teste para formatos Postman e JMeter, oferecendo aos desenvolvedores maior flexibilidade em sua abordagem de teste. Com essas opções de exportação, os desenvolvedores podem escolher a ferramenta de teste que melhor atende às suas necessidades e integrar os testes de API de forma contínua em seu fluxo de trabalho de desenvolvimento.
Como Instalar o Apidog CLI
Use o comando abaixo para instalar:
$ npm install -g apidog-cli
Executando com Dados em Tempo Real
Vá para "teste"> "Cenário de Teste", abra sua API desejada, clique no botão Adicionar Novo na página CI/CD.
Em seguida, copie o comando gerado e execute-o na linha de comando.
apidog run http://xxx/api/v1/api-test/ci-config/xxxx/detail?token=xxxx -r html,cli
Executando os Casos de Teste
$ apidog run examples/sample.apidog-cli.json -r cli,html,json
O relatório de teste será salvo no diretório apidog-reports.
Se você quiser personalizar o relatório, pode usar o resultado em um arquivo JSON para personalizar o relatório conforme necessário.
Conclusão
Seguindo os passos descritos neste guia, você deve agora ter uma boa compreensão de como instalar e executar o Newman para executar coleções do Postman. O Newman fornece uma interface de linha de comando que permite testes automatizados de API, tornando-o uma ferramenta valiosa para desenvolvedores que trabalham em um ambiente de integração contínua.
No entanto, se você está procurando uma alternativa ao Newman que oferece uma solução de CI/CD mais robusta, eu recomendaria fortemente considerar Apidog. Além de sua interface amigável para testes e documentação de API, o Apidog também fornece funcionalidades poderosas de CI/CD. Com recursos como exportação de casos de teste, ferramentas de colaboração, geração automática de documentação de API e integração perfeita com pipelines de CI/CD, o Apidog oferece uma solução abrangente para as necessidades de desenvolvimento e teste de APIs.
Seja você optar por continuar usando o Newman ou explorar o Apidog como uma alternativa, ambas as ferramentas podem melhorar muito seu processo de teste de API. No entanto, se você está buscando uma solução mais abrangente com funcionalidades fortes de CI/CD, o Apidog definitivamente vale a pena considerar.
