Tutorial Postman – Como usar para testes de API?

O que é carteiro?

Postman é uma ferramenta de teste de API escalonável que se integra rapidamente ao pipeline de CI/CD. Tudo começou em 2012 como um projeto paralelo de Abhinav Asthana para simplificar o fluxo de trabalho da API em testes e desenvolvimento. API significa Application Programming Interface, que permite que aplicativos de software se comuniquem entre si por meio de chamadas de API.

Por que usar o carteiro?

Com mais de 4 milhões de usuários hoje em dia, Postman Software se tornou uma ferramenta preferida para o acompanhamentowing razões:

  1. Acessibilidade – Para usar a ferramenta Postman, basta fazer login em suas próprias contas, facilitando o acesso aos arquivos a qualquer hora e em qualquer lugar, desde que um aplicativo Postman esteja instalado no computador.
  2. Uso de coleções – o Postman permite que os usuários criem coleções para suas chamadas de API do Postman. Cada coleção pode criar subpastas e múltiplas solicitações. Isso ajuda a organizar seus conjuntos de testes.
  3. Colaboração – Coleções e ambientes podem ser importados ou exportados facilitando o compartilhamento de arquivos. Um link direto também pode ser usado para compartilhar coleções.
  4. Criação de Ambientes – Ter vários ambientes auxilia em menos repetição de testes, pois pode-se usar a mesma coleção, mas para um ambiente diferente. É aqui que ocorrerá a parametrização, que discutiremos em lições futuras.
  5. Criação de testes – Pontos de verificação de teste, como verificação do status de resposta HTTP bem-sucedida, podem ser adicionados a cada chamada da API Postman, o que ajuda a garantir cobertura de teste.
  6. Testes de automação – Através do uso do Collection Runner ou Newman, os testes podem ser executados em múltiplas iterações, economizando tempo para testes repetitivos.
  7. Depuração – O console Postman ajuda a verificar quais dados foram recuperados, facilitando a depuração de testes.
  8. Integração contínua – Com sua capacidade de apoiar a integração contínua, as práticas de desenvolvimento são mantidas.

Como usar o Postman para executar APIs

Abaixo está o espaço de trabalho do Postman. Vamos explorar o processo passo a passo em Como usar o Carteiro e diferentes recursos da ferramenta Postman!

Como usar o Postman para executar APIs

  1. Novo – É aqui que você criará uma nova solicitação, coleção ou ambiente.
  2. Importar – Isso é usado para importar uma coleção ou ambiente. Existem opções como importar de arquivo, pasta, link ou colar texto bruto.
  3. Runner – Testes de automação podem ser executados através do Collection Runner. Isso será discutido mais detalhadamente na próxima lição.
  4. Abrir novo – Abra uma nova guia, janela Postman ou janela Runner clicando neste botão.
  5. Meu espaço de trabalho – você pode criar um novo espaço de trabalho individualmente ou em equipe.
  6. Convidar – Colabore em um espaço de trabalho convidando membros da equipe.
  7. Histórico – Solicitações anteriores que você enviou serão exibidas no Histórico. Isso torna mais fácil rastrear as ações que você realizou.
  8. Coleções – Organize seu conjunto de testes criando coleções. Cada coleção pode ter subpastas e múltiplas solicitações. Uma solicitação ou pasta também pode ser duplicada.
  9. Guia Solicitação – exibe o título da solicitação na qual você está trabalhando. Por padrão, “Solicitação sem título” seria exibido para solicitações sem títulos.
  10. Solicitação HTTP – Clicar aqui exibiria uma lista suspensa de diferentes solicitações, como GET, POST, COPY, DELETE, etc. Nos testes da API Postman, as solicitações mais comumente usadas são GET e POST.
  11. URL de solicitação – Também conhecido como endpoint, é aqui que você identificará o link para onde a API se comunicará.
  12. Salvar – Se houver alterações em uma solicitação, clicar em salvar é obrigatório para que novas alterações não sejam perdidas ou substituídas.
  13. Params – É aqui que você escreverá os parâmetros necessários para uma solicitação, como valores-chave.
  14. Autorização – Para acessar APIs, é necessária a autorização adequada. Pode ser na forma de nome de usuário e senha, token de portador, etc.
  15. Cabeçalhos – você pode definir cabeçalhos como tipo de conteúdo JSON dependendo das necessidades da organização.
  16. Corpo – É aqui que se pode personalizar otails em uma solicitação comumente usada na solicitação POST.
  17. Script de pré-solicitação – São scripts que serão executados antes da solicitação. Normalmente, scripts de pré-solicitação para o ambiente de configuração são usados ​​para garantir que os testes serão executados no ambiente correto.
  18. Testes – São scripts executados durante a solicitação. É importante ter testes, pois configura pontos de verificação para verificar se o status da resposta está ok, se os dados recuperados estão conforme o esperado e outros testes.

Trabalhando com solicitações GET

Solicitações Get são usadas para recuperar informações de um determinado URL. Não haverá alterações feitas no endpoint.

Usaremos o seguintewing URL para todos os exemplos neste tutorial do Postman https://jsonplaceholder.typicode.com/users

No espaço de trabalho

  1. Defina sua solicitação HTTP como GET.
  2. No campo URL da solicitação, insira o link
  3. Clique em Enviar
  4. Você verá a mensagem 200 OK
  5. Deve haver 10 resultados do usuário no corpo, o que indica que seu teste foi executado com sucesso.

Trabalhando com solicitações Get

*Nota: Pode haver casos em que a solicitação Get Postman não seja bem-sucedida. Pode ser devido a um URL de solicitação inválido ou à necessidade de autenticação.

Trabalhando com solicitações POST

As solicitações de postagem são diferentes da solicitação Get, pois há manipulação de dados com o usuário adicionando dados ao endpoint. Usando os mesmos dados do tutorial anterior em Get request, vamos agora adicionar nosso próprio usuário.

Passo 1) Clique em uma nova guia para criar uma nova solicitação.

Trabalhando com solicitações de postagem

Passo 2) Na nova aba

  1. Defina sua solicitação HTTP como POST.
  2. Insira o mesmo link no URL da solicitação: https://jsonplaceholder.typicode.com/users
  3. mude para a guia Corpo

Trabalhando com solicitações de postagem

Passo 3) No corpo,

  1. Clique em bruto
  2. Selecione JSON

Trabalhando com solicitações de postagem

Passo 4) Copie e cole apenas um resultado de usuário da solicitação get anterior, como abaixo. Certifique-se de que o código foi copiado corretamente com chaves emparelhadas e brackets. Altere o id para 11 e o nome para qualquer nome desejado. Você também pode alterar outrostails como o endereço.

[
    {
        "id": 11,
        "name": "Krishna Rungta",
        "username": "Bret",
        "email": "Sincere@april.biz",
        "address": {
            "street": "Kulas Light",
            "suite": "Apt. 556",
            "city": "Gwenborough",
            "zipcode": "92998-3874",
            "geo": {
                "lat": "-37.3159",
                "lng": "81.1496"
            }
        },
        "phone": "1-770-736-8031 x56442",
        "website": "hildegard.org",
        "company": {
            "name": "Romaguera-Crona",
            "catchPhrase": "Multi-layered client-server neural-net",
            "bs": "harness real-time e-markets"
        }
    }
]

Trabalhando com solicitações de postagem

*Nota: A solicitação de postagem online deve ter o formato correto para garantir que os dados solicitados serão criados. É uma boa prática usar Get first para verificar o formato JSON da solicitação. Você pode usar ferramentas como https://jsonformatter.curiousconcept.com/

Trabalhando com solicitações de postagem

Passo 5) Em seguida,

  1. Clique em Enviar.
  2. Status: 201 Criado deve ser exibido
  3. Os dados postados são showing no corpo.

Trabalhando com solicitações de postagem

Como parametrizar solicitações

A parametrização de dados é um dos recursos mais úteis do Postman. Em vez de criar as mesmas solicitações com dados diferentes, você pode usar variáveis ​​com parâmetros. Esses dados podem ser de um arquivo de dados ou de uma variável de ambiente. A parametrização ajuda a evitar a repetição dos mesmos testes e iterações podem ser usadas para teste de automação.

Os parâmetros são criados através do uso de double crespo brackets: {{amostra}}. Vamos dar uma olhada em um exemplo de uso de parâmetros em nossa solicitação anterior:

Parametrizar solicitações

Agora vamos criar uma solicitação get parametrizada.

Passo 1)

  1. Defina sua solicitação HTTP como GET
  2. Insira este link: https://jsonplaceholder.typicode.com/users. Substitua a primeira parte do link por um parâmetro como {{url}}. O URL da solicitação agora deve ser {{url}}/users.
  3. Clique em enviar.

Não deverá haver resposta, pois não definimos a origem do nosso parâmetro.

Parametrizar solicitações

Passo 2) Para usar o parâmetro você precisa definir o ambiente

  1. Clique no ícone do olho
  2. Clique em editar para definir a variável para um ambiente global que pode ser usado em todas as coleções.

Parametrizar solicitações

Passo 3) Na variável,

  1. defina o nome para o URL que é https://jsonplaceholder.typicode.com
  2. clique em Salvar.

Parametrizar solicitações

Passo 4) Clique em fechar se você vir a próxima tela

Parametrizar solicitações

Passo 5) Volte para sua solicitação Get e clique em enviar. Agora deve haver resultados para sua solicitação.

Parametrizar solicitações

*Nota: Certifique-se sempre de que seus parâmetros tenham uma origem, como uma variável de ambiente ou arquivo de dados, para evitar erros.

Como criar testes Postman

Testes Postman são códigos JavaScript adicionados a solicitações que ajudam a verificar resultados como status de sucesso ou falha, comparação de resultados esperados, etc. Geralmente começa com pm.test. Pode ser comparado a afirmações, verifica comandos disponíveis em outras ferramentas.

Vamos fazer algumas coisas básicas Teste de API usando o Postman para nossas solicitações de parametrização da lição anterior.

Passo 1) Vá para a solicitação de usuário GET do tutorial anterior.

  1. Mude para a guia de testes. No lado direito estão os códigos dos snippets.
  2. Na seção de snippets, clique em “Código de status: o código é 200”.

O painel é preenchido automaticamente

Crie testes de carteiro

Passo 2) Agora clique em Enviar. O resultado do teste agora deve ser exibido.

Crie testes de carteiro

Passo 3) Volte para a aba de teste e vamos adicionar outro teste. Desta vez compararemos o resultado esperado com o resultado real.

Na seção de snippets, clique em “Corpo da resposta: verificação do valor JSON”. Estaremos verificando se Leanne Graham tem o ID de usuário 1.

Crie testes de carteiro

Passo 4)

  1. Substitua “Seu nome de teste” do código por “Verifique se o usuário com id1 é Leanne Graham” para que o nome do teste especifique exatamente o que queremos testar.
  2. Substitua jsonData.value por jsonData[0].name. Para obter o caminho, verifique o corpo em Obter resultado anterior. Como Leanne Graham tem o ID do usuário 1, jsonData está no primeiro resultado, que deve começar com 0. Se você deseja obter o segundo resultado, use jsonData[1] e assim por diante para resultados posteriores.
  3. No eql, insira “Leanne Graham”
pm.test("Check if user with id1 is Leanne Graham", function () {
    var jsonData = pm.response.json();
    pm.expect(jsonData[0].name).to.eql("Leanne Graham");
});

Crie testes de carteiro

Passo 5) Clique em enviar. Agora deve haver dois resultados de teste aprovados para sua solicitação.

Crie testes de carteiro

*Nota: Existem diferentes tipos de testes que podem ser criados no Postman. Tente explorar a ferramenta e veja quais testes atendem às suas necessidades.

Como criar coleções

As coleções desempenham um papel importante na organização dos conjuntos de testes. Pode ser importado e exportado facilitando o compartilhamento de coleções entre a equipe. Neste tutorial, aprenderemos como criar e executar uma coleção.

Vamos começar criando uma coleção:

Passo 1) Clique no botão Novo no canto superior esquerdo da página.

Criar coleções

Passo 2) Selecione Coleção. A janela de criação de coleção deve aparecer.

Criar coleções

Passo 3) Insira o nome e a descrição da coleção desejada e clique em criar. Uma coleção agora deve ser criada.

Criar coleções

Passo 4) Volte para a solicitação Get anterior. Clique em Salvar

Criar coleções

Passo 5)

  1. Selecione Coleção de testes do Postman.
  2. Clique em Salvar na coleção de testes do Postman

Criar coleções

Passo 6) A coleção de testes do Postman agora deve conter uma solicitação.

Criar coleções

Passo 7) Repita as etapas 4 a 5 para a solicitação Post anterior para que a coleção agora tenha duas solicitações.

Criar coleções

Como executar coleções usando o Collection Runner

Existem duas maneiras de executar uma coleção: Collection Runner e Newman. Vamos começar executando a coleção no Collection Runner.

Passo 1) Clique no botão Runner localizado na parte superior da página ao lado do botão Importar.

Execute coleções usando o Collection Runner

Passo 2) A página do Collection Runner deve aparecer como abaixo. Sigawing é a descrição de vários campos

Execute coleções usando o Collection Runner

Passo 3) Execute sua coleção de testes do Postman configurando o seguintewing:

  • Escolha a coleção de testes do Postman - defina as iterações como 3
  • Defina o atraso como 2500 ms
  • Clique no botão Executar teste do Postman…

Execute coleções usando o Collection Runner

Passo 4) A página de resultados da execução deve ser exibida após clicar no botão Executar. Dependendo do atraso, você deverá ver os testes conforme eles são executados.

  1. Depois que os testes forem concluídos, você poderá ver o status do teste, se for Aprovado ou Reprovado, e os resultados por iteração.
  2. Você vê o status de aprovação para solicitações Get
  3. Como não tivemos nenhum teste para Post, deveria aparecer uma mensagem informando que a solicitação não tinha nenhum teste.

Execute coleções usando o Collection Runner

Você pode ver como é importante que haja testes em suas solicitações para que você possa verificar o status da solicitação HTTP se for bem-sucedido e os dados forem criados ou recuperados.

Como executar coleções usando Newman

Outra forma de administrar uma coleção é via Newman. As principais diferenças entre Newman e Collection Runner são as seguinteswing:

  1. Newman é um complemento para o Postman. Você precisará instalá-lo separadamente do aplicativo nativo.
  2. Newman usa a linha de comando enquanto o Collection Runner possui uma GUI.
  3. Newman pode ser usado para integração contínua.

Para instalar o Newman e executar nossa coleção a partir dele, faça o seguintewing:

Passo 1) Instale o nodejs usando este link: http://nodejs.org/download/

Passo 2) Abra a linha de comando e digite

 npm install -g newman

Newman agora deve estar instalado em seu computador.

Execute coleções usando Newman

Passo 3) Depois que o Newman estiver instalado, vamos voltar ao nosso espaço de trabalho do Postman. box, clique nos três pontos. As opções devem aparecer agora. Selecione Exportar.

Execute coleções usando Newman

Passo 4) Escolha Exportar coleção como coleção v2.1 (recomendado) e clique em Exportar.

Execute coleções usando Newman

Passo 5) Selecione o local desejado e clique em Salvar. É aconselhável criar uma pasta específica para seus testes do Postman. Uma coleção agora deve ser exportada para o diretório local escolhido.

Passo 6) Também precisaremos exportar nosso meio ambiente. Clique no ícone de olho ao lado do menu suspenso de ambiente em Global, selecione Baixar como JSON. Selecione o local desejado e clique em Salvar. É aconselhável que o ambiente esteja na mesma pasta da sua coleção.

Execute coleções usando Newman

Passo 7) O ambiente agora deve ser exportado para o mesmo diretório local da Coleção.

Passo 8) Agora volte para a linha de comando e altere o diretório onde você salvou a coleção e o ambiente.

 cd C:\Users\Asus\Desktop\Postman Tutorial

Passo 9) Execute sua coleção usando este comando:

 newman run PostmanTestCollection.postman_collection.json -e Testing.postman_globals.json

Os resultados da execução agora devem aparecer como abaixo.

Execute coleções usando Newman

Para guia, há uma referência a alguns códigos básicos de Newman para execução:

  1. Execute apenas uma coleção. Isso pode ser usado se não houver dependência de ambiente ou arquivo de dados de teste.
  2. newman run <collection name>
  3. Execute uma coleção e um ambiente. O indicador -e é para ambiente.
  4. newman run <collection name> -e <environment name>
  5. Execute uma coleção com o número desejado. de iterações.
  6. newman run <collection name> -n <no.of iterations>
  7. Execute com arquivo de dados.
  8. newman run <collection name> --data <file name>  -n <no.of iterations> -e <environment name>
  9. Defina o tempo de atraso. Isso é importante porque os testes podem falhar se forem executados sem demora devido a solicitações iniciadas sem que a solicitação anterior conclua o processamento no servidor do terminal.
newman run <collection name> -d <delay time>

Os nossos Guia de perguntas da entrevista do carteiro irá ajudá-lo a conseguir a entrevista e a conseguir o emprego dos seus sonhos para testes de software.

Resumo

  • Teste de API usando Postman: Postman é um aplicativo para testar APIs. Postman é uma das ferramentas mais populares usadas em testes de API, enviando solicitações ao servidor web e obtendo a resposta de volta
  • Acessibilidade, uso de coleções, colaboração, integração contínua são alguns dos principais recursos para aprender no Postman
  • É recomendado que você crie uma conta no Postman, para que suas coleções fiquem disponíveis online
  • Você pode parametrizar a solicitação no Postman
  • Você pode criar testes para verificar uma solicitação do carteiro
  • As coleções podem ser executadas usando Newman ou Collection Runner