Tutorial de teste de API: um guia completo para iniciantes

api testing tutorial

Este tutorial detalhado de teste de API explica tudo sobre o teste de API, serviços da Web e como introduzir o teste de API em sua organização:

Obtenha uma visão profunda do teste de API, juntamente com o conceito de teste shift-left e serviços da Web deste tutorial introdutório.

Conceitos como API da Web, como a API funciona (com exemplo do mundo real) e como ela é diferente dos Serviços da Web são bem explicados com exemplos neste tutorial.

=>ROLAR PARA BAIXOpara ver a lista completa de 5 tutoriais detalhados de teste de API para iniciantes

O que você aprenderá:

• Lista de tutoriais de teste de API
• Visão geral dos tutoriais nesta série de testes de API
• Tutorial de teste de API
  • Teste Shift Left
  • Ciclo de vida de desenvolvimento de software (SDLC) antes do teste Shift Left
  • Fases do teste de deslocamento à esquerda
  • API da web
  • Como funciona uma API?
  • Serviços web
  • Serviços da Web vs API da Web
• Apresentando o teste de API em sua organização
  • Mudança de foco para teste de API
  • Espectro total de testes de API
    • (i) Teste Funcional
    • (ii) Teste de Carga e Desempenho
    • (iii) Teste de Segurança
  • Como apresentar o teste de API em sua organização
  • Desafios comuns e maneiras de mitigá-los
    • # 1) Escolha da ferramenta certa
    • # 2) Especificações de teste ausentes
    • # 3) Curva de Aprendizagem
    • # 4) Conjunto de habilidades existentes
  • Estudo de caso
• Conclusão
  • Leitura recomendada

Lista de tutoriais de teste de API

Tutorial nº 1: Tutorial de teste de API: um guia completo para iniciantes
Tutorial # 2: Tutorial de serviços da web: componentes, arquitetura, tipos e exemplos
Tutorial nº 3: As 35 principais perguntas da entrevista sobre ASP.Net e API da Web com respostas
Tutorial nº 4: Tutorial POSTMAN: Teste de API usando POSTMAN
Tutorial # 5: Teste de serviços da Web usando o cliente Apache HTTP

Visão geral dos tutoriais nesta série de testes de API

Tutorial de teste de API

Esta seção o ajudará a obter um entendimento básico de Serviços da Web e API da Web, que, por sua vez, será útil para entender os principais conceitos nos próximos tutoriais desta série de Testes de API.

API (Application Programming Interface) é um conjunto de todos os procedimentos e funções que nos permitem criar um aplicativo acessando os dados ou recursos do sistema operacional ou plataformas. O teste de tais procedimentos é conhecido como Teste de API.

Teste Shift Left

Um dos tipos importantes de teste que está sendo solicitado hoje em dia nas Entrevistas de Teste de API é o Teste Shift Left. Este tipo de teste é praticado em quase todos os projetos que seguem uma Metodologia Ágil.

Antes do Shift Left Testing ser introduzido, o teste de software só entrava em cena depois que a codificação estava concluída e o código entregue aos testadores. Essa prática levava à correria de última hora para cumprir o prazo e também prejudicava muito a qualidade do produto.

Além disso, os esforços feitos (quando os defeitos foram relatados na última fase antes da produção) foram enormes, pois os desenvolvedores tiveram que passar pelas fases de design e codificação novamente.

Ciclo de vida de desenvolvimento de software (SDLC) antes do teste Shift Left

O fluxo SDLC tradicional era: Requisito -> Projeto -> Codificação -> Teste.

Desvantagens dos testes tradicionais

como abrir arquivo json no windows 10

• O teste está na extrema direita. Muitos custos são incorridos quando um bug é identificado no último minuto.
• O tempo gasto para resolver o bug e testá-lo novamente antes de promovê-lo para produção é enorme.

Portanto, uma nova ideia surgiu para mudar a fase de teste para a esquerda, o que levou ao Teste de Mudança para a Esquerda.

Leitura sugerida => Teste Shift Left: Um Mantra Secreto para o Sucesso do Software

Fases do teste de deslocamento à esquerda

O teste de deslocamento à esquerda levou a uma migração bem-sucedida da detecção de defeitos para a prevenção de defeitos. Também ajudou o software a falhar rapidamente e a corrigir todas as falhas o mais rápido possível.

API da web

Em termos gerais, uma API da Web pode ser definida como algo que leva a solicitação de um sistema cliente a um servidor web e envia de volta a resposta de um servidor web para uma máquina cliente.

Como funciona uma API?

Vejamos um cenário muito comum de reservar um voo em www.makemytrip.com, que é um serviço de viagens online que agrega informações de várias companhias aéreas. Ao fazer uma reserva de voo, você insere informações como data da viagem / data de retorno, classe, etc. e clica em pesquisar.

Isso mostrará o preço de várias companhias aéreas e sua disponibilidade. Nesse caso, o aplicativo interage com APIs de várias companhias aéreas e, assim, dá acesso aos dados da companhia aérea.

Outro exemplo é www.trivago.com que compara e relaciona o preço, disponibilidade, etc. de diferentes hotéis de uma determinada cidade. Este site se comunica com APIs de vários hotéis para acessar o banco de dados e lista os preços e a disponibilidade de seu site.

Assim, uma API Web pode ser definida como “uma interface que facilita a comunicação entre uma máquina cliente e o servidor web”.

Serviços web

Os serviços da Web são (como a API da Web) os serviços que atendem de uma máquina para outra. Mas a principal diferença que surge entre API e Web Services é que os Web Services usam uma rede.

É seguro dizer que todos os serviços da Web são APIs da Web, mas todas as APIs da Web não são serviços da Web (explicado na última parte do artigo). Portanto, os serviços da web são um subconjunto da API da web. Consulte o diagrama abaixo para saber mais sobre a API da Web e os serviços da Web.

API da Web vs. Serviços da Web

Serviços da Web vs API da Web

Tanto a API da Web quanto os serviços da Web são usados ​​para facilitar a comunicação entre o cliente e o servidor. A principal diferença está apenas na maneira como eles se comunicam.

Cada um deles requer um corpo de solicitação que seja aceitável em um idioma específico, suas diferenças em fornecer uma conexão segura, sua velocidade de comunicação com o servidor e resposta ao cliente, etc.

As diferenças entre serviços da Web e API da Web estão listadas abaixo para sua referência.

Serviço de internet

• Os Web Services geralmente usam XML (Extensible Markup Language), o que significa que são mais seguros.
• Os Web Services são mais seguros, pois os Web Services e as APIs fornecem SSL (Secure Socket Layer) durante a transmissão de dados, mas também fornece WSS (Web Services Security).
• O serviço da web é um subconjunto da API da web. Por exemplo, Os serviços da Web são baseados apenas em três estilos de uso, ou seja, SOAP, REST e XML-RPC.
• Os serviços da Web sempre precisam de uma rede para operar.
• Os serviços da Web suportam “aplicativos diferentes de um código”. Isso significa que um código mais genérico é escrito em diferentes aplicativos.

API da web

• Uma API da Web geralmente usa JSON (JavaScript Object Notation), o que significa que a API da Web é mais rápida.
• A API da Web é mais rápida porque o JSON é leve, ao contrário do XML.
• As APIs da Web são o superconjunto dos Serviços da Web. Por exemplo, Todos os três estilos de Web Services estão presentes na API Web também, mas, fora isso, usa outros estilos como JSON - RPC.
• A API da Web não requer necessariamente uma rede para operar.
• A API da Web pode ou não oferecer suporte à interoperabilidade, dependendo da natureza do sistema ou aplicativo.

Apresentando o teste de API em sua organização

Em nosso dia a dia, todos nós estamos tão acostumados a interagir com os Apps com APIs e ainda nem pensamos nos processos de back-end que conduzem a funcionalidade subjacente.

Por exemplo, Vamos considerar que você está navegando pelos produtos na Amazon.com e vê um produto / negócio de que realmente gosta e deseja compartilhá-lo com sua rede do Facebook.

No momento em que você clica no ícone do Facebook na seção de compartilhamento da página e insere as credenciais da sua conta do Facebook para compartilhar, você está interagindo com uma API que conecta perfeitamente o site da Amazon ao Facebook.

Mudança de foco para teste de API

Antes de discutir mais sobre os testes de API, vamos discutir os motivos pelos quais os aplicativos baseados em API ganharam popularidade nos últimos tempos.

Existem vários motivos pelos quais as organizações estão fazendo a transição para produtos e aplicativos baseados em API. E alguns deles estão listados abaixo para sua referência.

# 1) Os aplicativos baseados em API são mais escaláveis ​​quando comparados aos aplicativos / software tradicionais. A taxa de desenvolvimento de código é mais rápida e a mesma API pode atender a mais solicitações sem nenhum código importante ou alterações de infraestrutura.

#dois) As equipes de desenvolvimento não precisam começar a programar do zero sempre que começarem a trabalhar no desenvolvimento de um recurso ou aplicativo. As APIs geralmente reutilizam funções, bibliotecas, procedimentos armazenados, etc. existentes e repetíveis e, portanto, esse processo pode torná-los mais produtivos em geral.

Por exemplo, Se você é um desenvolvedor que trabalha em um site de comércio eletrônico e deseja adicionar a Amazon como um processador de pagamentos, não é necessário escrever o código do zero.

Tudo que você precisa fazer é configurar a integração entre o seu site e a API da Amazon usando chaves de integração e chamar a API da Amazon para processar pagamentos durante o checkout.

# 3) As APIs permitem uma integração fácil com outros sistemas tanto para aplicativos autônomos com suporte quanto com produtos de software baseados em API.

Por exemplo , Vamos considerar que você deseja enviar uma remessa de Toronto para Nova York. Você fica online, navega até um conhecido site de frete ou logística e insere as informações necessárias.

Depois de fornecer as informações obrigatórias, ao clicar no botão Obter taxas - no back end, este site de logística pode se conectar com várias APIs e aplicativos de operadoras e prestadores de serviços para obter as taxas dinâmicas para a combinação de locais de origem para destino.

Espectro total de testes de API

O teste de APIs não se restringe a enviar uma solicitação à API e apenas analisar a resposta quanto à exatidão. As APIs precisam ser testadas quanto ao seu desempenho sob diferentes cargas de vulnerabilidades.

Vamos discutir isso em detalhes.

(i) Teste Funcional

O teste funcional pode ser uma tarefa desafiadora devido à falta de uma interface GUI.

Vamos ver como o abordagem de teste funcional para APIs é diferente do aplicativo baseado em GUI e também discutiremos alguns exemplos em torno dele.

para) A diferença mais óbvia é que não há GUI para interagir. Os testadores que geralmente fazem testes funcionais baseados em GUI acham um pouco mais difícil fazer a transição para testes de aplicativos não GUI quando comparados a alguém que já está familiarizado com eles.

Inicialmente, antes mesmo de começar a testar a API, você precisará testar e verificar o próprio processo de autenticação. O método de autenticação varia de uma API para outra API e envolve algum tipo de chave ou token para autenticação.

Se você não conseguir se conectar à API com êxito, os testes adicionais não poderão prosseguir. Esse processo pode ser considerado comparável à autenticação do usuário nos aplicativos padrão em que você precisa de credenciais válidas para fazer login e usar o aplicativo.

b) Testar validações de campo ou validação de dados de entrada é muito importante durante o teste de APIs. Se uma interface real baseada em formulário (GUI) estivesse disponível, as validações de campo poderiam ser implementadas no front end ou back end, garantindo assim que um usuário não tivesse permissão para inserir valores de campo inválidos.

Por exemplo, Se um aplicativo precisa que o formato de data seja DD / MM / AAAA, podemos aplicar essa validação no formulário de coleta de informações para garantir que o aplicativo esteja recebendo e processando uma data válida.

Isso, no entanto, não é o mesmo para aplicativos de API. Precisamos garantir que a API seja bem escrita e seja capaz de aplicar todas essas validações, distinguir entre dados válidos e inválidos e retornar o código de status e a mensagem de erro de validação para o usuário final por meio de uma resposta.

c) Testar a exatidão das respostas da API para respostas válidas e inválidas é realmente crucial. Se um código de status de 200 (significando tudo OK) for recebido como uma resposta da API de teste, mas se o texto de resposta disser que um erro foi encontrado, isso é um defeito.

Além disso, se a própria mensagem de erro estiver incorreta, isso pode ser muito enganoso para o cliente final que está tentando se integrar a esta API.

Na captura de tela abaixo, o usuário inseriu um peso inválido, que é mais do que os 2267 kg aceitáveis. A API responde com o código de status de erro e a mensagem de erro. No entanto, a mensagem de erro menciona incorretamente as unidades de peso como libras em vez de KG. Esse é um defeito que pode confundir o cliente final.

(ii) Teste de Carga e Desempenho

As APIs devem ser escalonáveis ​​por design.

Isso, por sua vez, torna o Load e Teste de performance essencial, especialmente se o sistema que está sendo projetado deve atender a milhares de solicitações por minuto ou hora, dependendo da necessidade. A execução rotineira de testes de carga e desempenho na API pode ajudar a avaliar o desempenho, as cargas de pico e o ponto de interrupção.

Esses dados são úteis durante o planejamento de expansão de um aplicativo. Ter essas informações disponíveis ajudará a apoiar as decisões e o planejamento, especialmente se a organização estiver planejando adicionar mais clientes, o que significaria mais solicitações recebidas.

Por exemplo , digamos que com base nos requisitos fornecidos, sabemos que a API projetada precisa atender a pelo menos 500 solicitações por hora e manter o tempo médio de resposta de menos de 0,01 segundo.

Com base em nossos testes de carga e desempenho, descobrimos que, desde que a API receba menos de 500 solicitações por hora, ela é capaz de manter o SLA para o tempo médio de resposta. No entanto, se ele receber outras 200 solicitações, o tempo médio de resposta aumentará e o ponto de interrupção será atingido quando a solicitação de entrada exceder 1200 por hora.

Normalmente, verifica-se que, durante as fases iniciais de design, a ênfase geralmente está nos aspectos funcionais da API. Conforme o tempo passa, um produto passa a oferecer suporte a vários clientes ativos, ou seja, o teste de desempenho da API e o teste de carga entram em cena de maneira mais rotineira.

(iii) Teste de Segurança

As interfaces de programação de aplicativos ou APIs são vulneráveis ​​e são o ponto de acesso mais fácil para hackers mal-intencionados que desejam acessar dados ou obter o controle de um aplicativo.

Isso pode levar qualquer empresa a problemas jurídicos, onde devido a uma violação de segurança, pessoas e / ou organizações não intencionais podem acessar os dados do cliente por meio de uma API venerável.

Teste de segurança é um ramo especializado de teste e deve ser tratado por especialistas. Os recursos de teste de segurança podem ser de dentro da organização ou de consultores independentes.

Leia também = >> O que são testes de contrato de pacto

Como apresentar o teste de API em sua organização

O processo de introdução do teste de API em qualquer organização é semelhante ao processo usado para implementar ou lançar qualquer outra ferramenta e estrutura de teste.

A tabela abaixo resume as etapas principais junto com o resultado esperado de cada etapa.

Desafios comuns e maneiras de mitigá-los

Vamos discutir alguns dos desafios comuns que as equipes de QA enfrentam ao tentar implementar uma estrutura de teste de API em uma organização.

# 1) Escolha da ferramenta certa

Selecionar a ferramenta correta para o trabalho é o desafio mais comum. Existem várias ferramentas de teste de API disponíveis no mercado.

Pode parecer muito atraente implementar a ferramenta mais recente e cara disponível no mercado - mas se não trouxer os resultados desejados, então essa ferramenta é inútil.

Portanto, sempre escolha a ferramenta que atende aos requisitos 'essenciais' com base em suas necessidades organizacionais.

Aqui está um exemplo de matriz de avaliação de ferramenta para as Ferramentas API disponíveis

# 2) Especificações de teste ausentes

Como testadores, precisamos saber os resultados esperados para testar um aplicativo com eficácia. Isso costuma ser um desafio, pois para saber os resultados esperados, precisamos ter requisitos claros e precisos - o que não é o caso.

Por exemplo , considere os requisitos fornecidos abaixo:

“O aplicativo deve aceitar apenas uma data de envio válida e todos os requisitos inválidos devem ser rejeitados”

Esses requisitos estão faltando detalhes importantes e são muito ambíguos - como estamos definindo uma data válida? E quanto ao formato? Estamos retornando alguma mensagem de rejeição ao usuário final, etc.?

Exemplo de requisitos claros:

1) O aplicativo deve aceitar apenas uma data de envio válida.

A data de envio é considerada válida se for

• Não no passado
• Maior ou igual à data de hoje
• Está em formato aceitável: DD / MM / AAAA

2)

Código de status de resposta = 200
Mensagem: OK

com o que abrir arquivos swf

3) A data de envio que não atender aos critérios acima deve ser considerada inválida. Se um cliente enviar uma data de remessa inválida, ele deverá responder com a (s) seguinte (s) mensagem (ns) de erro:

3,1

Código de status de resposta NÃO 200
Erro: a data de envio fornecida é inválida; certifique-se de que a data está no formato DD / MM / AAAA

3,2

Código de status de resposta NÃO 200
Erro: a data de envio fornecida está no passado

# 3) Curva de Aprendizagem

Conforme mencionado anteriormente, a abordagem para teste de API é diferente quando comparada à abordagem seguida durante o teste de aplicativos baseados em GUI.

Se você estiver contratando especialistas internos ou consultores para testes de API, a curva de aprendizado da abordagem de teste de API ou da ferramenta de teste de API pode ser mínima. Qualquer curva de aprendizado, neste caso, estaria associada à aquisição do conhecimento do produto ou da aplicação.

Se um membro da equipe existente for designado para aprender o teste de API, dependendo da ferramenta de escolha, a curva de aprendizado pode ser média a alta, junto com a mudança da abordagem do teste. A curva de aprendizado para o produto ou aplicativo em si pode ser baixo-médio, dependendo se este testador testou o aplicativo antes ou não.

# 4) Conjunto de habilidades existentes

Isso está diretamente relacionado ao ponto anterior sobre a curva de aprendizado.

Se um testador estava fazendo a transição de um teste baseado em GUI, ele precisaria mudar a abordagem de teste e aprender a nova ferramenta ou estrutura conforme necessário. Por exemplo. Se a API aceita as solicitações no formato JSON, o testador precisa aprender o que é JSON para começar a criar os testes.

Estudo de caso

Tarefa

Para aumentar a escala de um aplicativo existente, uma empresa queria oferecer um produto em API e também um aplicativo GUI padrão. A equipe de QA foi solicitada a fornecer um plano de cobertura de teste para garantir que eles estivessem prontos para acomodar os testes de API além dos testes regulares baseados em GUI.

Desafios

• Nenhum dos outros produtos de software tinha arquitetura baseada em API, portanto, para acomodar os testes em torno dessa tarefa, a equipe precisa estabelecer o processo de teste de API do zero. Isso significa que as ferramentas deveriam ser avaliadas, pré-selecionadas, finalizadas e a equipe treinada para os testes.
• Não houve orçamento adicional alocado para aquisição e implementação da ferramenta. Isso significa que a equipe teve que escolher uma ferramenta de teste de API gratuita ou de código aberto e alguém da equipe existente teve que ser treinado para realizar essa tarefa.
• Não havia requisitos para campos de API e validação de dados. Os requisitos eram “deve funcionar da mesma forma que o aplicativo GUI correspondente”.

A abordagem seguida pela equipe para mitigar riscos e contornar os desafios

• A equipe de QA trabalhou com a equipe do projeto para identificar os seguintes requisitos:
  • Tipo de API (REST / SOAP): RESTO
  • Testes necessários (funcional, carga, segurança): Teste funcional apenas
  • Testes automatizados necessários (Sim / Não): Opcional por enquanto
  • Relatórios de teste (Sim / Não): Requerido
• A equipe de QA fez a avaliação das ferramentas disponíveis Ferramentas de teste de API com base nos requisitos indispensáveis. Postman API Tool foi finalizado como uma ferramenta de sua escolha, pois era gratuita e fácil de usar, minimizando assim a curva de aprendizado e tinha o potencial de automatizar testes, e vinha com bons relatórios embutidos.
• O mesmo testador que testou o aplicativo foi treinado para usar o Postman para criar os testes iniciais, eliminando assim quaisquer lacunas de conhecimento do produto.
• Para lidar com os requisitos ausentes, a equipe do projeto construiu a documentação de nível de campo de alto nível usando Swagger. No entanto, isso deixou algumas lacunas em termos de formatos de dados aceitáveis ​​e isso foi discutido com a equipe do projeto e os formatos esperados foram acordados e documentados.

Conclusão

Os aplicativos baseados em API ganharam popularidade nos últimos tempos. Esses aplicativos são mais escaláveis ​​em comparação com os aplicativos / software tradicionais e permitem uma integração mais fácil com as outras APIs ou aplicativos.

Este tutorial de Teste de API explicou em detalhes tudo sobre Teste de API, Teste Shift Left, Serviços da Web e API da Web. Também exploramos as diferenças entre Web Services e Web API com exemplos.

Na segunda parte do tutorial, discutimos todo o espectro do Teste de API, como introduzir o Teste de API em sua organização e alguns desafios comuns neste processo, juntamente com soluções para eles.

Confira nosso próximo tutorial para saber mais sobre Web Services junto com exemplos !!

PRÓXIMO Tutorial

Leitura recomendada

• Teste Alfa e Teste Beta (um guia completo)
• Teste Funcional Vs Teste Não Funcional
• Tutorial de teste de usabilidade: um guia de primeiros passos completo
• Guia completo de teste de verificação de compilação (teste BVT)
• Tutorial de teste de DevOps: como o DevOps afetará os testes de controle de qualidade?
• Tutorial de teste de acessibilidade (um guia passo a passo completo)
• Melhores ferramentas de teste de software 2021 (QA Test Automation Tools)
• O que é teste de software? Mais de 100 tutoriais de teste manual gratuitos