Teste de API: o que é, como fazer e boas práticas

Interface de programação de aplicações (API) é um software para que aplicações e serviços interajam entre si. Ela fornece a interface que facilita a transferência dos dados e da lógica entre diversos sistemas de hardware e software. 

O aplicativo móvel de um banco, por exemplo, usa uma API para acessar a câmera do seu telefone quando você precisa tirar a foto de um cheque e depositar remotamente na sua conta.

Sem as APIs, as interações digitais que usamos todos os dias nos computadores, smartphones, TVs e outros aparelhos não seriam possíveis.

O que são testes de API?

Os desenvolvedores fazem testes para saber se as APIs atendem às expectativas quanto a funcionalidade, desempenho, confiabilidade e segurança. A intenção é encontrar bugs e outros comportamentos inesperados para que os usuários não recebam um produto ruim ou perigoso. Você precisa garantir que as APIs funcionem de forma eficiente e eficaz, ou elas não serão adotadas.

Porém, os testes de API podem não ser tão fáceis quanto parecem. Normalmente, as APIs usam protocolos e padrões com os quais você normalmente não trabalha. Esses protocolos e padrões são necessários para que diferentes plataformas, aplicações e sistemas conversem entre si. Portanto, você precisa testar não só a funcionalidade de uma API, mas também o desempenho, a segurança e os componentes funcionando juntos, tudo para criar uma interface confiável.

Por que você deve fazer testes de API?

Usamos as APIs para fazermos o trabalho diário, encontrarmos informações importantes e muito mais. De acordo com o relatório "State of the Internet", da Akamai, as chamadas de API representam 83% de todo o tráfego na web. Como as APIs são importantíssimas no dia a dia dos usuários, testá-las deve ser prioridade, pelos seguintes motivos:  

• Elas independem da linguagem: as APIs usam formatos como XML e JSON para trocar dados. Por isso, você pode usar qualquer linguagem ao criar a automação dos testes. 
• Elas independem da GUI: as APIs podem ser testadas sem a interface de usuário para chegar a funcionalidade principal da aplicação e encontrar erros e bugs.
• Cobertura aprimorada de testes: as APIs incluem recursos para criar scripts de automação com maior cobertura. 
• Reduz o custo dos testes: os testes de APIs acusam pequenos bugs nas funções principais antes de serem testadas na GUI. Esses pequenos bugs podem virar um grande problema durante o teste da GUI; portanto, ao encontrar e corrigir os bugs durante os testes de API, você economiza tempo e dinheiro.
• Lançamento mais rápido do produto: os testes de API normalmente levam uma fração do tempo necessário para realizar testes completos de regressão da IU. Assim, os erros podem ser encontrados e corrigidos de forma mais rápida e eficiente, e novas compilações podem ser lançadas com mais rapidez.
• Eles determinam se as APIs funcionam corretamente: os testes ajudam a garantir que a API faça o que você espera dela.
• Garantem que as APIs suportem a carga: execute testes que aplicam a quantidade de tráfego esperada para as APIs. É uma forma de simular vários usuários enviando solicitações simultâneas e, assim, testar a robustez de sua aplicação. 
• Compatibilidade de testes: os testes devem garantir que a API funcione em todos os aparelhos, navegadores e sistemas operacionais.
• Antecipam os erros do usuário: os testes podem mostrar como os usuários podem vir a atrapalhar. Essas informações antecipam os erros de usuário e melhoram seu design.

Quer saber mais sobre o desenvolvimento de uma API? Confira: “Como fazer uma API.”

Como testar uma API

Assim como na maioria dos projetos de tecnologia, você não pode iniciar os testes de API sem um plano. Com ele, você determina seus objetivos e como os realizará. Veja a seguir algumas dicas para começar o processo de testes de API:

• Entenda os requisitos: documente os requisitos da API e responda às seguintes perguntas:

• Qual é o propósito da API?
• Quem é o público-alvo?
• Quais problemas fazem parte dos testes?
• Qual é o resultado desejado?
• Quais são os recursos e as funções da API?
• Qual é o fluxo de trabalho da aplicação?
• Quais integrações a API aceita?
• Quais são as prioridades dos testes?

• Configure o ambiente dos testes: configure o ambiente com base nos requisitos da API. Configure o banco de dados e o servidor de acordo com os requisitos da aplicação. Em seguida, faça uma chamada de API para garantir que tudo esteja configurado e que nada seja interrompido antes de começar os testes.
• Escolha as ferramentas de testes da API: a menos que você planeje testar tudo manualmente, é necessária uma ferramenta de teste de API para estruturar e gerenciar os casos de teste.
• Decida quais tipos de teste de API você fará: Após configurar o ambiente de testes e garantir tudo funcionando, você precisa decidir para que testar a API. 

Quais tipos de teste de API você pode fazer?

O que você decide testar determina o tipo de teste a ser realizado. Para testar recursos e funções, por exemplo, você pode fazer um teste funcional.

São vários os tipos de testes de API à disposição: 

• Teste funcional: testa diferentes funções na base do código. Os testes representam situações específicas para garantir que as funções da API funcionem dentro dos parâmetros planejados e esperados.
• Teste de confiabilidade: serve para confirmar que a API opera sem falhas durante um período específico num ambiente específico.
• Teste de carga: monitora o desempenho da API em condições normais e de pico.
• Teste de segurança: verifica se a API é segura contra ameaças externas. Os testes incluem metodologias de criptografia, controle de acesso à API, gerenciamento de direitos do usuário e validação da autorização.
• Teste da IU: envolve testar a interface de usuário da API. Seu foco é a interface vinculada à API, e não a própria API. Os testes de IU podem dar uma visão geral da integridade e da usabilidade do aplicativo no front-end e no back-end.
• Teste negativo: mostra o que acontece quando o aplicativo recebe uma entrada inválida ou não intencional. Assim, você descobre o que corta o sistema e, então, desenvolve respostas mais apropriadas. Por exemplo: adicionar uma letra num campo de números deve disparar aviso e não causar falha no aplicativo. 
• Teste de validação: serve para confirmar que a API foi desenvolvida corretamente e que tudo funciona.

Teste manual x teste automatizado

O teste manual é um processo muito prático no qual um profissional de QA executa cada teste um a um. Os testadores se envolvem em todas as partes do processo, da criação do caso de teste até a execução. Eles validam os recursos, procuram bugs e escrevem os relatórios de erros sem ferramentas de automação.

O teste manual exige mais tempo e pode ser enfadonho. A automação executa mais casos de teste, melhora a cobertura dos testes e geralmente é mais eficiente. 

Por que usar o teste manual?

O teste manual tem uma atenção mais focada no processo dos testes. Criar e executar manualmente os próprios testes dá a você um controle mais sutil sobre o processo. Além disso, há menos riscos de os testes gerarem falsos negativos, o que pode criar muito trabalho extra para validar os erros relatados como verdadeiros ou não.

Os seguintes tipos de testes podem ser manuais:

• Testes exploratórios
• Testes de usabilidade
• Testes de IU
• Testes ad hoc

É recomendável usar os testes manuais para observar pequenas mudanças. Até a menor alteração exige escrever um novo código para executar um teste automatizado, o que pode demorar mais do que fazer um breve teste manual. 

Por que usar o teste automatizado?

A maior vantagem na automação dos testes de API é fazer mais testes em menos tempo. Ela aumenta a produtividade e deixa os testes mais eficientes. Testes mais rápidos levam a correções mais rápidas e ao lançamento mais rápido dos produtos.

Os seguintes tipos de testes podem ser automatizados:

• Testes funcionais
• Teste de carregamento
• Testes de desempenho
• Testes de validação
• Testes dinâmicos
• Testes orientados por dados
• Testes de erros
• Testes em várias linguagens
• Testes de regressão

Quais são as práticas recomendadas nos testes de API?

Embora os testes exploratórios e de interface do usuário devam ser manuais, a maioria dos testes de API deve ser automatizada. Veja a seguir algumas práticas recomendadas nos testes automatizados de API. Elas visam a simplificar os testes, a realizar mais testes em menos tempo, a economizar dinheiro e a lançar um produto com melhor qualidade.

Documente tudo

O sucesso dos testes pode ser determinado por como você define os requisitos de negócios e casos de teste. A maioria das suas APIs não tem uma GUI de front-end para referência; portanto, é essencial ter uma documentação que especifique claramente cada campo e os parâmetros associados. Os testadores consultam a documentação para cobrir todos os casos de uso necessários.

Você também precisa criar relatórios de teste detalhados e abrangentes, que documentem os motivos das falhas nos testes. Com esses relatórios, fica mais fácil para os desenvolvedores identificarem as áreas que precisam ser corrigidas.

Use a abordagem DRY

A abordagem "não se repita" (DRY) serve para evitar a repetição de códigos. Se o código for comum a componentes e ações em várias APIs, inclua-o numa biblioteca que seja de fácil acesso a todos que precisarem dele.

Comece com as APIs pequenas

Para facilitar a rotina de testes, comece com as APIs simples, com apenas uma ou duas entradas (uma API de login, por exemplo). Com isso, você cria confiança e garante que o ambiente de testes funciona corretamente antes de lidar com as APIs maiores.