Sobes.tech
Junior

Fala sobre o Postman e as suas capacidades na testagem de API.

sobes.tech IA

Resposta da IA

O Postman é uma aplicação de desktop e uma plataforma web para desenvolvimento e teste de APIs. Permite enviar pedidos HTTP, visualizar respostas, criar coleções de pedidos, automatizar testes, documentar APIs e colaborar em projetos.

As principais funcionalidades do Postman para testar APIs:

  • Criar e enviar pedidos: Suporta todos os principais métodos HTTP (GET, POST, PUT, DELETE, PATCH). Permite configurar parâmetros de pedido, cabeçalhos, corpo do pedido (formulários, JSON, XML, etc.).
  • Visualizar e analisar respostas: Mostra o código de estado, cabeçalhos e corpo da resposta. Permite formatar e procurar dados na resposta.
  • Trabalhar com coleções: Organiza pedidos em pastas e categorias. Útil para agrupar testes relacionados.
  • Variáveis e ambientes: Armazena e usa variáveis (URL, tokens, etc.) em pedidos. Permite trocar rapidamente entre diferentes ambientes de teste (dev, staging, prod).
  • Scripts Pre-request e Tests:
    • Pre-request Scripts: Executam-se antes de enviar o pedido. Podem ser usados para preparar dados, gerar tokens, etc. Escritos em JavaScript.
    • Tests: Executam-se após receber a resposta. Permitem verificar o código de estado, cabeçalhos, corpo da resposta, tempo de resposta e outros parâmetros. Escritos em JavaScript usando o framework Chai.js.
  • Automatização de testes com Collection Runner: Permite executar toda a coleção ou pedidos selecionados automaticamente. Pode configurar a ordem de execução, iterações, atrasos. Os resultados são exibidos num relatório.
  • Integração com sistemas CI/CD: Possibilidade de executar testes do Postman a partir da linha de comandos com Newman (CLI-runner para Postman) e integração com Jenkins, GitLab CI, GitHub Actions, etc.
  • Documentação de API: Criação automática de documentação com base nos pedidos da coleção. Útil para partilhar com outras equipas ou clientes.
  • Trabalho colaborativo: Possibilidade de partilhar coleções, variáveis e ambientes com outros membros da equipa.

Exemplo de script para verificar o estado da resposta e a presença de um campo no corpo da resposta:

// Verificar o código de estado da resposta
pm.test("Código de estado é 200", function () {
    pm.response.to.have.status(200);
});

// Verificar a presença do campo "success" no corpo da resposta (espera-se um valor booleano)
pm.test("O corpo da resposta tem a propriedade 'success'", function () {
    const responseJson = pm.response.json();
    pm.expect(responseJson).to.have.property('success');
    pm.expect(responseJson.success).to.be.a('boolean'); // Verificação opcional do tipo
});

Exemplo de uso de variáveis de ambiente:

// Usar a variável {{baseUrl}} na URL do pedido
// Obter o token no Pre-request Script e guardá-lo numa variável de ambiente
pm.environment.set("authToken", responseData.token);

// Usar a variável {{authToken}} no cabeçalho Authorization do pedido

O Postman facilita bastante o teste de APIs, tornando-o mais eficiente e conveniente.