Postman Tutorial

O que é a Postman?

Postman é uma ferramenta escalável para testes de API que se integra rapidamente a um pipeline de CI/CD. Ela surgiu em 2012 como um projeto paralelo de Abhinav Asthana para simplificar o fluxo de trabalho de APIs em testes e desenvolvimento. API significa Interface de Programação de Aplicativos, que permite que aplicativos de software se comuniquem entre si por meio de chamadas de API.

👉 Inscreva-se gratuitamente no projeto de teste de API ao vivo

Por que usar Postman?

Com mais de 4 milhões de usuários hoje em dia, Postman O software se tornou uma ferramenta de escolha pelos seguintes motivos:

1. Acessibilidade – Para usar o Postman Com essa ferramenta, bastaria fazer login em suas próprias contas, facilitando o acesso aos arquivos a qualquer hora e em qualquer lugar, desde que... Postman aplicativo está instalado no computador.
2. Uso de coleções – Postman permite que os usuários criem coleções para seus Postman Chamadas de API. Cada coleção pode criar subpastas e múltiplas requisiçõ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 múltiplos ambientes ajuda a reduzir a repetição de testes, pois é possível usar a mesma coleção para um ambiente diferente. É aqui que a parametrização entra em ação, assunto que abordaremos em lições futuras.
5. Criação de testes – Pontos de verificação de teste, como a verificação de um status de resposta HTTP bem-sucedido, podem ser adicionados a cada teste. Postman chamadas de API, que ajudam a garantir cobertura de teste.
6. Testes automatizados – Através do uso do Collection Runner ou do Newman, os testes podem ser executados em múltiplas iterações, economizando tempo em testes repetitivos.
7. Depuração – Postman O console 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 Postman para executar APIs

Abaixo está o Postman Espaço de trabalho. Vamos explorar o processo passo a passo em Como usar Postman e diferentes características do Postman ferramenta!

1. Novo – Aqui você criará uma nova solicitação, coleção ou ambiente.
2. Importar – Esta opção é usada 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, Postman Janela ou Janela do 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 várias requisições. Uma requisiçã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 exibirá uma lista suspensa com diferentes tipos de solicitação, como GET, POST, COPY, DELETE, etc. Postman Testes de API, as solicitações mais utilizadas são GET e POST.
11. URL da solicitação – Também conhecido como endpoint, é aqui que você identificará o link com o qual 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. Parâmetros – Aqui você escreverá os parâmetros necessários para uma solicitação, como valores de chave.
14. Autorização – Para acessar as APIs, é necessária a devida autorização. Ela pode ser feita por meio de um nome de usuário e senha, um token de acesso (bearer token), etc.
15. Cabeçalhos – Você pode definir cabeçalhos, como o tipo de conteúdo JSON, dependendo das necessidades da organização.
16. Corpo – É aqui que se podem personalizar os detalhes de uma solicitação, geralmente usado em uma 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 requisição. É importante ter testes, pois eles estabelecem pontos de verificação para confirmar se o status da resposta está correto, se os dados recuperados estão de acordo com o esperado e outros testes.

Trabalhando com solicitações GET

As requisições GET são usadas para recuperar informações da URL fornecida. Não haverá alterações no endpoint.

Usaremos a seguinte URL para todos os exemplos neste Postman tutorial 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á uma mensagem "200 OK".
5. O corpo da requisição deve conter 10 resultados de usuários, o que indica que o teste foi executado com sucesso.

*Nota: Pode haver casos em que o Get Postman A solicitação pode não ter sido bem-sucedida. Isso pode ocorrer devido a um URL de solicitação inválido ou à necessidade de autenticação.

Trabalhando com solicitações POST

As requisições POST diferem das requisições GET, pois envolvem manipulação de dados, com o usuário adicionando informações ao endpoint. Usando os mesmos dados do tutorial anterior sobre requisições GET, vamos agora adicionar nosso próprio usuário.

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

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

Passo 3) No corpo,

1. Clique em bruto
2. Selecione JSON

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 e colchetes emparelhados. Altere o id para 11 e o nome para qualquer nome desejado. Você também pode alterar outros detalhes, como o endereço.

[
    {
        "id": 11,
        "name": "Krishna Rungta",
        "username": "Bret",
        "email": "[email protected]",
        "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"
        }
    }
]

*Nota: A requisição POST online deve ter o formato correto para garantir que os dados solicitados sejam criados. É uma boa prática usar o método GET primeiro para verificar o formato JSON da requisição. Você pode usar ferramentas como... https://jsonformatter.curiousconcept.com/

Passo 5) Em seguida,

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

Como parametrizar solicitações

A parametrização de dados é um dos recursos mais úteis do PostmanEm vez de criar as mesmas solicitações com dados diferentes, você pode usar variáveis ​​com parâmetros. Esses dados podem vir 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 chaves duplas: {{sample}}. Vamos dar uma olhada em um exemplo de uso de parâmetros em nossa solicitação anterior:

Agora vamos criar uma requisiçã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.

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 como um ambiente global, que pode ser usado em todas as coleções.

Passo 3) Na variável,

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

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

Passo 5) Volte à sua solicitação GET e clique em enviar. Agora você deverá ver os resultados da sua solicitação.

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

Como Criar Postman Testes

Postman Os testes são JavaCódigos de script adicionados às requisições que ajudam a verificar resultados, como status de sucesso ou falha, comparação de resultados esperados, etc. Geralmente começam com pm.test. Podem ser comparados aos comandos asserts e verify disponíveis em outras ferramentas.

Vamos fazer algumas coisas básicas Teste de API utilização Postman para nossas solicitações parametrizadas 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

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

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.

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 do resultado em "Obter resultado" anteriormente. Como Leanne Graham tem o ID de usuário 1, jsonData está no primeiro resultado, que deve começar com 0. Se você quiser obter o segundo resultado, use jsonData[1] e assim por diante para os resultados subsequentes.
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");
});

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

*Nota: Existem diferentes tipos de testes que podem ser criados em 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 de conjuntos de testes. Elas podem ser importadas e exportadas, facilitando o compartilhamento 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.

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

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

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

Passo 5)

1. Selecionar Postman Coleta de testes.
2. Clique em Salvar para Postman Coleta de testes

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

Passo 7) Repita os passos 4 e 5 para a solicitação POST anterior, de forma que a coleção agora tenha duas solicitaçõ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.

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

Passo 3) Corra o seu Postman Teste a coleta configurando o seguinte:

• Escolha Postman coleção de testes - Defina iterações como 3
• Defina o atraso como 2500 ms
• Clique em Executar Postman Teste… botão

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.

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 seguintes:

1. Newman é um complemento para 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 seguinte:

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.

Passo 3) Uma vez instalado o Newman, vamos voltar ao nosso Postman workspace.Na caixa Collections, clique nos três pontos. As opções devem aparecer agora. Selecione Export.

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

Passo 5) Selecione o local desejado e clique em Salvar. É aconselhável criar uma pasta específica para o seu Postman testes. 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.

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.

O guia contém 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.

newman run <collection name>

2. Execute uma coleção e um ambiente. O indicador -e é para ambiente.

newman run <collection name> -e <environment name>

3. Execute uma coleção com o número desejado. de iterações.

newman run <collection name> -n <no.of iterations>

4. Execute com arquivo de dados.

newman run <collection name> --data <file name>  -n <no.of iterations> -e <environment name>

5. 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>

Nossas Postman guia de perguntas para entrevista Vai te ajudar a se sair bem na entrevista e a conseguir o emprego dos seus sonhos em testes de software.

comum Postman Cenários de solução de problemas

1. Erros 401 Não autorizado ou 403 Proibido

   Isso acontece quando sua solicitação não possui credenciais de autenticação válidas.
   Como consertar: DoubleVerifique seu tipo de autorização (Chave de API, Token de Portador ou Autenticação Básica). Se estiver usando tokens, certifique-se de que não expiraram. Gere novos tokens ou atualize as credenciais da sessão, se necessário.

2. 400 Bad Request

   Você receberá esse erro quando a sintaxe ou os parâmetros da solicitação estiverem incorretos.
   Como consertar: Valide o corpo do seu JSON ou XML usando um formatador como o JSONLint. Certifique-se de que seus parâmetros correspondam exatamente ao que a API espera, incluindo a diferenciação entre maiúsculas e minúsculas e o tipo de dados.

3. 500 Internal Server Error

   Geralmente, trata-se de um problema no servidor, mas também pode ocorrer quando a carga útil não está estruturada corretamente.
   Como consertar: Tente novamente a solicitação com formatos de dados válidos. RevConsulte a documentação da API para obter as definições de esquema adequadas antes de enviar a solicitação novamente.

4. Tempo limite da solicitação (408)

   Ocorre quando o servidor demora muito para responder.
   Como consertar: Verifique sua conexão com a internet e confirme se o URL do endpoint está acessível. Tente enviar payloads menores ou ajuste a configuração de tempo limite em Postman se disponível.

5. Variáveis ​​de ambiente não estão funcionando

   As variáveis ​​podem não ser resolvidas corretamente se não estiverem definidas ou se o escopo estiver incorreto.
   Como consertar: Abra o ícone de olho ao lado do seletor de ambiente para revisar as variáveis ​​definidas. Certifique-se de estar usando o ambiente correto (Global, Ambiente ou Coleção).

6. Testes falhando inesperadamente

   Quando os scripts de teste não se comportam como esperado, geralmente trata-se de um erro de lógica ou de sintaxe.
   Como consertar: Use console.log() para imprimir resultados intermediários e depurar seu script. Verifique se você está referenciando corretamente os dados de resposta usando pm.response.json().

7. Cabeçalhos ou tipo de conteúdo incorretos

   Cabeçalhos incorretos podem causar rejeições do servidor ou erros de incompatibilidade de dados.
   Como consertar: Ao enviar dados JSON, especifique sempre o Content-Type como application/json. Remova cabeçalhos duplicados ou conflitantes.

8. O coletor de dados não está exibindo os resultados dos testes.

   Isso acontece quando seus scripts de teste não contêm instruções pm.test().
   Como consertar: Adicione scripts de teste adequados, como:

   pm.test("Status code is 200", function () {
     pm.response.to.have.status(200);
   });
   

   Isso garante que o Collection Runner capture e relate os resultados dos testes.

9. Newman não consegue realizar os testes.

   Se o Newman apresentar erros, isso pode ser devido a caminhos de arquivo incorretos ou versões desatualizadas.
   Como consertar: Atualize o Newman executando o comando `npm install -g newman`. Verifique se os arquivos `.json` da coleção e do ambiente existem nos caminhos corretos.

10. Resposta lenta ou solicitações com atraso

    Cargas úteis pesadas ou atrasos no servidor podem tornar seus testes mais lentos.
    Como consertar: Use paginação ou conjuntos de dados menores. Habilite o Postman Console para medir tempos de resposta e identificar endpoints lentos.

Melhores Práticas para um Corte Suave Postman Testes

1. Use ambientes e variáveis ​​de forma inteligente.

Crie ambientes dedicados para Desenvolvimento, Controle de Qualidade e Produção. Armazene URLs base, chaves de API e tokens em variáveis ​​em vez de codificá-los diretamente no código. Isso torna a transição entre ambientes perfeita.

2. Organize coleções e espaços de trabalho

Mantenha suas coleções modulares — agrupe as solicitações por módulo da API. Por exemplo: “Gerenciamento de Usuários”, “Autenticação” ou “Pedidos”. Use nomes descritivos para as solicitações, a fim de facilitar a colaboração.

3. Controle as versões das suas coleções.

Salve suas coleções no Postman Armazene-os na nuvem ou exporte-os para o Git. Isso garante backup, controle de versões e facilita o trabalho em equipe.

4. Elabore testes claros e autoexplicativos.

Mantenha suas asserções de teste legíveis. Por exemplo:

pm.test("Response time is below 200ms", function () {
  pm.expect(pm.response.responseTime).to.be.below(200);
});

Isso melhora a legibilidade dos testes e a clareza da depuração.

5. Automatize com scripts de pré-solicitação

Utilize scripts de pré-requisição para gerar timestamps, calcular assinaturas ou buscar tokens dinamicamente antes de executar a requisição. Isso minimiza as atualizações manuais.

6. Monitore as APIs regularmente

Estabelecer Postman Monitores que executam testes automaticamente em intervalos regulares. Eles alertam quando as APIs param de funcionar ou o desempenho cai.

7. Mantenha o ambiente de trabalho limpo

Remova ambientes, variáveis ​​e coleções obsoletas. Um espaço de trabalho organizado evita confusões e execuções acidentais de testes em endpoints descontinuados.

8. Reutilize trechos de código comuns

Em vez de escrever as mesmas asserções repetidamente, salve trechos reutilizáveis ​​para cabeçalhos, verificações de corpo e validações de resposta.

9. Integração com CI/CD usando Newman

Use o Newman para automatizar testes no Jenkins, GitHub Actions ou Azure Pipelines. Isso garante que suas APIs sejam testadas antes de cada implantação.

10. Documente tudo

Postman Permite gerar e compartilhar documentação automaticamente. Documentação atualizada não só melhora a colaboração da equipe, como também aumenta a visibilidade da sua marca no mercado de materiais de estudo.

Dicas rápidas de depuração

• Abra o Postman cônsul (Ctrl + Alt + C) para visualizar os registros e os detalhes da solicitação.
• Use o Recurso de proxy Para capturar tráfego de API móvel ou local.
• Valide seus dados antes de enviar as solicitações.
• Lembre-se: nomes de cabeçalho em Postman e guarante que os mesmos estão maiúsculas e Minúsculas.
• If Postman Se o aplicativo apresentar comportamento errático, limpe o cache ou reinicie-o.

Conselho de profissional: Comece sempre pelo básico. Envie uma requisição GET simples primeiro e confirme a conectividade. Depois, vá adicionando cabeçalhos, corpo da requisição e testes gradualmente. Depurar passo a passo é mais rápido do que analisar uma requisição sobrecarregada e com falha.

Perguntas Frequentes