Tutorial POSTMAN: Teste de API usando POSTMAN

postman tutorial api testing using postman

Este tutorial passo a passo explica o teste de API usando o POSTMAN, incluindo os princípios básicos do POSTMAN, seus componentes e a solicitação e resposta de amostra:

Vimos as perguntas mais frequentes ASP.Net e perguntas da entrevista da Web API em nosso tutorial anterior. Ao percorrer este tutorial, você aprenderá como abordamos o teste de API por meio do POSTMAN para qualquer URL.

Postman é uma ferramenta ou aplicativo de teste de API muito simples e intuitivo. Cada componente do POSTMAN é muito importante, pois tem seu próprio significado.

=> Leia a série completa de testes de API aqui .

como obter um email falso

Lista de todos os tutoriais do Postman desta série

Tutorial nº 1: Introdução ao Postman (este tutorial)
Tutorial # 2: Como usar o Postman para testar formatos de API Diff
Tutorial nº 3: Postman: escopos variáveis ​​e arquivos de ambiente
Tutorial nº 4: Coleções do Postman: importar, exportar e gerar amostras de código
Tutorial # 5: Automatizando validações de resposta com asserções
Tutorial # 6: Postman: scripts de pré-solicitação e pós-solicitação
Tutorial nº 7: Postman Advanced Scripting
Tutorial # 8: Postman - integração de linha de comando com Newman
Tutorial # 9: Postman - Modelos de relatórios com Newman
Tutorial # 10: Postman - Criando documentação de API
Tutorial nº 11: Perguntas da entrevista do carteiro

Visão geral dos tutoriais na série Postman

O que você aprenderá:

• Introdução ao POSTMAN
• Instalação POSTMAN
  • Postman Native App
  • Guia alternativo de instalação do Quick Postman
  • Blocos de construção do POSTMAN
    • # 1) Solicitação
    • # 2) Coleção
    • # 3) Meio Ambiente
  • Salvar uma solicitação na coleção
• Solicitação e resposta de amostra
• Atualização: Informações Adicionais
  • O que é uma API?
  • Cliente POSTMAN
    • Como baixar o cliente POSTMAN?
  • Chamar APIs REST usando o cliente POSTMAN
    • # 1) GET Call
    • # 2) PÓS-CHAMADA
    • # 3) PUT Call
    • # 4) Excluir chamada
  • Desafios no teste de API
• Conclusão
  • Leitura recomendada

Introdução ao POSTMAN

POSTMAN é um cliente API usado para desenvolver, testar, compartilhar e documentar APIs. É usado para teste de back-end, onde inserimos a URL do endpoint, envia a solicitação ao servidor e recebe a resposta de volta do servidor. A mesma coisa também pode ser realizada por meio de modelos de API como o Swagger. Tanto no Swagger quanto no POSTMAN, não precisamos construir uma estrutura (ao contrário do Parasoft) para buscar a resposta do serviço.

Esse é o principal motivo pelo qual o POSTMAN é usado com frequência pelos desenvolvedores e engenheiros de automação para garantir que o serviço esteja instalado e funcionando junto com a versão de construção de uma API que está sendo implantada na região.

Ele essencialmente ajuda a atingir os endpoints da API, criando rapidamente solicitações de acordo com a especificação da API e dissecando os vários parâmetros de resposta como o código de status, cabeçalhos e o próprio corpo de resposta real.

Aqui está um tutorial em vídeo:

Postman oferece muitos recursos avançados, como:

• Desenvolvimento de API.
• Configurando endpoints Mock para APIs que ainda estão em desenvolvimento.
• Documentação da API.
• Asserções para as respostas recebidas da execução do endpoint da API.
• Integração com ferramentas CI-CD como Jenkins, TeamCity, etc.
• Automatizando a execução de testes de API etc.

Agora que passamos pela introdução formal da ferramenta, vamos prosseguir para a parte de instalação.

Instalação POSTMAN

Postman está disponível em 2 opções.

1. Como um aplicativo do Chrome (já está obsoleto e não tem suporte dos desenvolvedores do Postman)
2. Aplicativo nativo para diferentes plataformas como Windows, Mac OS, Linux, etc.

Como os aplicativos do Chrome estão sendo preteridos e têm um acoplamento estreito com o navegador Chrome (em alguns casos, a versão real do navegador), vamos nos concentrar principalmente no uso do aplicativo nativo que nos dá mais controle e tem menos dependências externas.

Postman Native App

Postman Native app é um app autônomo que está disponível para baixar em várias plataformas de sistema operacional, como Windows, Mac OS, Linux, etc. Isso pode ser baixado como qualquer outro aplicativo, dependendo da plataforma do usuário.

O processo de instalação também é bastante simples. Basta clicar duas vezes no instalador baixado (para Windows e Mac) e seguir as instruções.

Assim que a instalação for bem-sucedida, basta abrir o aplicativo Postman para começar.

Veremos como criar uma solicitação simples para qualquer API de código aberto disponível e veremos os vários componentes da solicitação e a resposta recebida quando a solicitação é executada usando o aplicativo Postman.

É altamente recomendável fazer login / inscrever-se no aplicativo Postman usando uma conta de e-mail existente. Uma conta conectada preserva todas as coleções e solicitações do Postman que são salvas durante a sessão e garante que as solicitações ainda estejam disponíveis para trabalhar quando o mesmo usuário fizer logon na próxima vez.

Por favor, consulte o Observação seção para obter detalhes sobre o endpoint de API falso publicamente disponível.

Vamos ilustrar um exemplo de solicitação GET para este URL que retornaria 100 postagens em resposta como uma carga JSON.

Vamos começar e ver as etapas que precisam ser seguidas:

# 1) Abra o aplicativo Postman (se ainda não tiver feito login com a conta existente ou nova, primeiro faça login com as credenciais apropriadas).

A seguir está a imagem da tela inicial da IU do Postman:

#dois) Crie uma nova solicitação e preencha os detalhes de acordo com o endpoint que usaremos para nosso teste ou ilustração. Vamos testar uma solicitação get para um endpoint da API REST http://dummy.restapiexample.com/api/v1/employees

# 3) Depois que as propriedades da solicitação forem preenchidas, pressione SEND para executar a solicitação ao servidor que hospeda o endpoint.

# 4) Assim que o servidor responder, podemos verificar os vários dados em torno da resposta.

Vamos ver cada um deles em detalhes.

Por padrão, quando a resposta é concluída, a guia do corpo da resposta é selecionada e exibida. Outros parâmetros para uma resposta, como o código de status da resposta, o tempo necessário para a conclusão da solicitação e o tamanho da carga útil, são mostrados logo abaixo dos cabeçalhos da solicitação (como na figura abaixo).

Para obter detalhes refinados sobre os parâmetros de resposta, como Tamanho da resposta e Tempo de resposta, você pode simplesmente passar o mouse sobre cada um desses valores e o Postman mostrará uma visão detalhada com detalhes mais refinados para cada uma dessas propriedades.

Por exemplo, para o tempo de solicitação - ele irá dissecá-lo em componentes individuais, como tempo de conexão, tempo de soquete, pesquisa de DNS, handshake, etc.

Da mesma forma, para o tamanho da resposta, ele mostrará uma divisão de quanto tamanho os cabeçalhos são constituídos e qual é o tamanho real da resposta.

Agora, vamos dar uma olhada nas outras guias de resposta, ou seja, Cookies e Cabeçalhos. No mundo da web, os cookies têm uma grande importância em termos de conduzir experiências do lado do cliente e muitas informações relacionadas à sessão para obter todas as informações sobre os cookies que foram retornados do servidor. Você pode alternar para a guia cookies e ver isso.

Da mesma forma, os cabeçalhos de resposta contêm muitas informações benéficas sobre a solicitação que foi processada. Basta navegar até a guia de cabeçalhos na seção de resposta para dar uma olhada nos cabeçalhos de resposta.

Um ponto importante a se notar aqui é que todas as solicitações que você faz ao servidor são armazenadas no histórico do Postman para referência futura (a guia Histórico está disponível no painel esquerdo do aplicativo).

Isso ajuda a prevenir a criação de solicitações sempre que você precisa obter uma resposta para a mesma solicitação e também ajuda a evitar tarefas rotineiras rotineiras. Se necessário, você pode consultar as solicitações anteriores (e também as respostas) em um momento futuro.

Observação: Para ilustrar as solicitações e respostas de amostra, usaremos servidores API falsos disponíveis publicamente que permitirão que todos os tipos de solicitações HTTP sejam feitas e que retornem uma resposta HTTP válida.

Para citar alguns, usaremos os sites de endpoint falsos de API abaixo como referência:

1. Exemplo de API Rest
2. JSON Placeholder Typicode

Guia alternativo de instalação do Quick Postman

O POSTMAN é uma ferramenta aberta e está disponível para quem navega na internet. Você pode seguir as etapas abaixo e obter a ferramenta POSTMAN instalada em sua máquina local.

Passo 1: Abrir Google e pesquise a ferramenta POSTMAN. Você obterá o resultado da pesquisa abaixo. Em seguida, você pode clicar em Baixar aplicativo Postman e será redirecionado para o site getpostman.

Caso contrário, você pode navegar diretamente para este URL para obter a ferramenta POSTMAN.

Passo 2: Selecione a versão POSTMAN com base em seu sistema operacional. No nosso caso, usaremos o POSTMAN para o sistema operacional Windows. Além disso, estamos usando o Windows-64 bits, portanto, vamos baixar e instalar o POSTMAN para 64 bits.

Etapa 3: Depois de clicar no botão Download, um arquivo postman.exe será baixado em seu local. Clique naquele arquivo. É uma instalação com um clique, como qualquer outro aplicativo que permitirá que você instale o add-on POSTMAN para o seu navegador.

Passo 4: Depois de instalar o aplicativo, clique no aplicativo (que deve ser colocado em sua área de trabalho). Como você pode ver na imagem abaixo, temos seis entidades diferentes para as quais você basicamente precisará de três blocos de construção, ou seja, Solicitação, Coleção e Ambiente, que serão discutidos na próxima seção.

É isso!! Instalamos e inicializamos com sucesso o aplicativo POSTMAN.

Blocos de construção do POSTMAN

O POSTMAN tem uma variedade de blocos de construção, mas para nosso propósito, vamos discutir os três principais blocos de construção que são essenciais para cada operação do POSTMAN.

Esses três principais blocos de construção são:

# 1) Solicitação

Uma solicitação nada mais é do que uma combinação do URL completo (que inclui todos os parâmetros ou chaves), cabeçalhos HTTP, corpo ou carga útil. Todos esses atributos formam uma solicitação. POSTMAN permite que você salve sua solicitação e este é um bom recurso do aplicativo que nos permite usar a mesma solicitação quantas vezes quisermos.

Clique em Novo -> Solicitação

# 2) Coleção

Deve haver algo onde você salvará suas solicitações em massa. Este é o cenário onde a coleção entra em cena. Podemos dizer que uma coleção é um repositório no qual podemos salvar todas as nossas solicitações. Geralmente, as solicitações que atingem a mesma API são mantidas na mesma coleção.

Clique em Novo -> Coleção.

# 3) Meio Ambiente

Um ambiente é uma região onde todas as suas operações em uma API ocorrerão. Pode ser TUP, QA, Dev, UAT ou PROD. Cada projeto já terá as regiões configuradas e você só terá que declarar suas variáveis ​​globais como URL, id e senha do token, chaves de contexto, chaves de API, chaves de documentos e assim por diante.

Clique em Novo -> Ambiente.

Salvar uma solicitação na coleção

Agora tentaremos salvar uma solicitação de amostra em uma coleção e usaremos a mesma solicitação para atingir uma API.

Passo 1: No canto superior direito, você verá o botão “+ Novo”. Clique neste botão e você terá a lista dos blocos de construção que foram exibidos quando você iniciou o aplicativo pela primeira vez.

Passo 2: Clique em Solicitar.

Etapa 3: Forneça o nome da solicitação, que é um campo obrigatório. Em seguida, clique em “+ Criar Coleção”.

Passo 4: Depois de clicar em “+ Criar coleção”, será solicitado um nome (por exemplo, Coleção de amostra). Insira o nome da coleção e pressione Enter.

Etapa 5: Clique no “Salvar na coleta de amostra” botão.

Solicitação e resposta de amostra

Esta seção específica fornecerá uma visão profunda de como testar uma API no POSTMAN.

Como você pode ver na imagem abaixo, temos nossa Solicitação que já criamos (Teste para SoftwareTestingHelp). Além disso, você pode ver uma lista suspensa (ao lado da URL) que contém os verbos ou métodos que são suportados pelo POSTMAN.

Eles são chamados de verbos HTTP. Tentaremos atualizar algo usando o método PUT e então iremos recuperar o mesmo usando o método GET. Presumo que os leitores estejam cientes da funcionalidade desses verbos HTTP que são usados ​​em testes de API.

Agora, temos um URL e um método de solicitação. Tudo o que precisamos são os cabeçalhos e a carga útil ou o corpo. Em alguns casos, precisamos gerar tokens (com base nas necessidades de uma API).

Declararemos nossos cabeçalhos HTTP, ou seja, Content-Type e Accept. Aceitar nem sempre é obrigatório, pois ele decide o formato em que recuperaremos nossa resposta. Por padrão, a resposta é sempre JSON.

Não há necessidade de alterar os valores desses cabeçalhos, pois o POSTMAN fornecerá as sugestões quando você digitar nas áreas de texto da chave e do valor.

Em seguida, passaremos para a próxima seção obrigatória que é Corpo. Aqui, forneceremos a carga útil na forma de JSON. Estamos cientes de como escrever nosso próprio JSON, portanto, tentaremos criar nosso próprio JSON.

Pedido de amostra

URL: http://www.mocky.io/v2/5cd6c3f23000004b006061c5

Cabeçalhos

Tipo de conteúdo: aplicativo / JSON
Aceitar = aplicativo / JSON

Corpo

Agora acertar

Assim que tiver um pedido completo, clique no “botão Enviar” e veja o código de resposta. Um código 200 OK significa operação bem-sucedida. Na imagem abaixo você pode ver que atingimos o URL com sucesso.

O próximo passo

Agora, vamos realizar outra operação chamada GET. Tentaremos buscar o mesmo registro que acabamos de criar.

Não exigimos um corpo ou carga útil para a operação GET. Como já temos nossa solicitação de amostra usando o método PUT, tudo o que precisamos é alterar o método para GET.

Assim que mudarmos para GET, entraremos no serviço novamente. Como você pode ver na imagem abaixo, temos exatamente o que passamos e é assim que o POSTMAN funciona.

Atualização: Informações Adicionais

O que é uma API?

API (Application Programming Interface) é um arquivo jar, que contém vários métodos e interfaces para executar uma ação específica.

Consulte o exemplo abaixo e a captura de tela:

1. Crie um método de soma, que adiciona duas variáveis ​​e retorna a soma de duas variáveis.
2. Em seguida, crie uma classe de calculadora que contém vários outros métodos, como adição, subtração, multiplicação, divisão e assim por diante. Pode haver algumas classes auxiliares também. Agora combine todas as classes e interfaces e crie um arquivo jar chamado Calculator.jar e publique-o. Use a API Calculator para acessar os métodos presentes nela.
3. Algumas APIs são de código aberto (Selenium) que podem ser editados e algumas são licenciadas (UFT) que não podem ser editadas.

Leitura sugerida => Principais ferramentas de gerenciamento de API

Como exatamente esses métodos estão sendo chamados?

Os desenvolvedores irão expor uma interface, uma plataforma para chamar a API da calculadora e nós criamos o objeto da classe calculator e chamamos o método sum ou qualquer método.

Suponha que este arquivo calculator.jar seja criado por alguma empresa e ela use esse utilitário por meio da interface de IU, então testamos esse aplicativo de calculadora usando IU e o automatizamos usando QTP / Selenium e isso é chamado de Teste de Front End.

Alguns aplicativos não possuem IU, portanto, para acessar esses métodos, criamos um objeto da classe e passamos os argumentos para teste e isso é chamado Teste de back-end . O envio da solicitação e o recebimento da resposta ocorrerão por meio de JSON Arquivos / XML.

Consulte o diagrama abaixo:

Cliente POSTMAN

• POSTMAN é um cliente REST usado para realizar testes de API de backend.
• No POSTMAN, passamos a chamada da API e verificamos a resposta da API, os códigos de status e a carga útil.
• Swagger é outra ferramenta de cliente HTTP em que criamos a documentação da API e, por meio do swagger, também podemos acessar a API e obter a resposta.
• Consulte o link https://swagger.io/
• Você pode usar o Swagger ou o POSTMAN para testar as APIs, e isso depende das empresas e de qual cliente usar.
• No POSTMAN usamos principalmente chamadas GET, POST, PUT e DELETE.

Como baixar o cliente POSTMAN?

Abra o Google Chrome e baixe o aplicativo POSTMAN disponível na loja de aplicativos do Chrome.

Chamar APIs REST usando o cliente POSTMAN

No POSTMAN temos muitos métodos, mas usamos apenas GET, PUT, POST e DELETE

• PUBLICAR - Esta chamada cria uma nova entidade.
• OBTER - Esta chamada envia a solicitação e recebe a resposta.
• POR - Esta chamada cria uma nova entidade e atualiza a entidade existente.
• EXCLUIR - Esta chamada exclui a entidade existente.

As APIs podem ser acessadas usando a interface do usuário como a plataforma bancária ou onde a interface do usuário não está disponível, como os sistemas de back-end, onde usamos o cliente REST API como o POSTMAN

Outros clientes também estão disponíveis, como SOAP UI, que é um cliente REST e SOAP, clientes REST avançados como JMeter pode chamar as APIs diretamente do navegador. POSTMAN é a melhor ferramenta para executar operações POST e GET.

Leia também => Lista de tutoriais aprofundados do SoapUI

como abrir um arquivo bittorrent

Envie uma solicitação e obtenha uma resposta no cliente POSTMAN:

Para fins de teste, usamos as APIs fornecidas aqui .

Verifique cada chamada CRUD no cliente POSTMAN usando a API fornecida pelo site fictício.

No teste de API, validamos principalmente os pontos abaixo:

• Os códigos de status de resposta, consulte página wiki para detalhes.
• A mensagem de resposta e o corpo da resposta JSON.
• No teste de API, primeiro, peça ao desenvolvedor para fornecer a URL do endpoint. Veja este URL de endpoint https://reqres.in/.

# 1) GET Call

Envia a solicitação e recebe a resposta.

Etapas para testar a API REST:

• Passar https://reqres.in//api/users?page=2 (? é um parâmetro de consulta que filtra o resultado como imprimir todas as informações do usuário na página 2, o parâmetro de consulta depende do desenvolvedor como ele definirá) como URI no cliente POSTMAN.
• O parâmetro de consulta é definido por (?) E o parâmetro de caminho é definido por (/).
• Selecione o método GET.

• Forneça cabeçalhos (se necessário) como User-Agent: “Software”.

• Clique no botão ENVIAR.
• Se a API estiver funcionando bem, em resposta obteremos:
  • Status 200 - OK, significa que a resposta foi recebida com sucesso.
  • Resposta JSON Payload.
  • String Message

• Outro Exemplo do MÉTODO GET, onde buscamos informações sobre um usuário específico, ou seja, ID de usuário = 3. Insira URI = https://reqres.in/api/users/3

• Se os dados não estiverem disponíveis em nossa pesquisa, obteremos uma mensagem de status JSON e 404 em branco.

# 2) PÓS-CHAMADA

Crie um novo usuário ou uma entidade.

Etapas para executar:

• Selecione um POST no menu suspenso e use este URL de serviço “https://reqres.in/api/users/100”
  
• Vá para Corpo -> selecione RAW -> Como estamos passando JSON.
• Selecione JSON no menu suspenso e cole o script de carga útil.
• Passe esta carga útil {“nome”: ”Morpheus”, ”trabalho”: ”líder”}

• JSON começa com chaves e armazena dados no formato de chave e valor.
• Passe o tipo de conteúdo do cabeçalho = application / json.
• Pressione o botão ENVIAR.

• Mediante solicitação bem-sucedida, obtemos a resposta abaixo:
  • Status 201 - Criado, a resposta foi recebida com sucesso.
  • Carga útil de resposta
  • Cabeçalho

# 3) PUT Call

Atualiza ou cria uma nova entidade.

Etapas para criar uma chamada PUT:

• Use este URL de serviço “https://reqres.in/api/users/206” e carga útil {“nome”: “Morpheus”, ”trabalho”: “Gerente”
• Acesse o cliente POSTMAN e selecione o método PUT -> Vá para o corpo -> Selecione RAW> passe JSON e selecione JSON na lista suspensa e cole o script de carga útil.
• JSON começa com chaves e armazena dados no formato de valor-chave.
• Pressione o botão ENVIAR, para uma solicitação bem-sucedida, você receberá a resposta abaixo.
  • Status 200 - Ok, resposta recebida com sucesso.
  • Carga útil de resposta
  • Cabeçalho
  • Trabalho atualizado para “gerente”

# 4) Excluir chamada

• Exclua o usuário, use este URL de serviço “/ api / users / 423” e esta carga {“nome”: “Naveen”, ”trabalho”: “QA”}.
• Vá para POSTMAN e selecione o método DELETE, carga útil não necessária.
• Exclui ID do usuário = 423 se disponível no sistema.
  • Status 204 - Sem conteúdo, resposta recebida com sucesso.
  • Nenhum payload recebido, ID de usuário excluída.
  • Cabeçalho

Desafios no teste de API

• Os casos de teste devem ser projetados de forma a cobrir a cobertura do teste.
• Projetar casos de teste é simples quando a API carrega menos parâmetros, mas a complexidade aumenta quando o número de parâmetros é grande.
• Atualize regularmente sua cobertura de teste com uma mudança nos requisitos de negócios. Se um novo parâmetro for adicionado, aumente o conjunto de equipamentos de teste
• Sequenciando chamadas API corretamente.
• Explore as condições de limite e desempenho.

Conclusão

Neste tutorial, discutimos as dicas importantes para começar a usar a ferramenta de teste Postman API. Aprendemos a instalar a ferramenta Postman como um aplicativo independente e discutimos como podemos criar uma solicitação simples e observar a resposta gerada.

Vimos como navegar para as diferentes partes das informações de resposta, bem como revisar e recuperar as solicitações da guia de histórico.

Acreditamos que agora você pode realizar uma operação bem-sucedida em uma API. A operação bem-sucedida em uma API não significa copiar e colar todo o corpo, cabeçalhos e outros blocos necessários e tornar a execução do teste bem-sucedida.

É sobre como você se sente confortável em escrever seu próprio JSON, navegando para qualquer campo específico em um JSON com a ajuda da chave ou parâmetros do documento, compreendendo matrizes em JSON, etc.

A ferramenta cliente POSTMAN é usada para realizar testes de back-end e principalmente para realizar chamadas GET, PUT, POST, DELETE.

Neste tutorial, aprendemos como acertar as chamadas do cliente POSTMAN e como validar a resposta que recebemos do servidor e também abordamos os desafios no teste de API.

O teste de API é muito importante para encontrar brechas nas APIs, pois os hackers vão explorá-las e causar perdas financeiras. O teste de API parece simples, mas devemos ser muito cautelosos e tentar testar com todas as combinações possíveis.

Em nosso próximo tutorial, aprenderemos como usar a ferramenta Postman para formatos Diff API!

PREV Tutorial | PRÓXIMO Tutorial

Leitura recomendada

• Tutorial Parasoft SOAtest: Ferramenta de teste de API sem script
• Tutorial de teste de API: um guia completo para iniciantes
• Melhores ferramentas de teste de software 2021 (QA Test Automation Tools)
• Tutorial de teste destrutivo e teste não destrutivo
• Teste Funcional Vs Teste Não Funcional
• Tutorial da ferramenta de teste de acessibilidade WAVE
• Tutorial de teste de acessibilidade (um guia passo a passo completo)
• Tutorial de teste de SOA: Metodologia de teste para um modelo de arquitetura SOA