Como Testar APIs de Forma Eficiente – Insomnia e Postman

Você sabe como testar APIs de forma eficiente? Aprenda a utilizar as ferramentas corretas para testar e facilitar o processo de desenvolvimento das suas APIs.

Caso prefira esse conteúdo no formato de vídeo-aula, assista ao vídeo abaixo ou acesse o nosso canal do YouTube!

O que você aprende neste vídeo

Resposta rápida: Com uma API em JavaScript que devolve a pontuação final dos pilotos da Fórmula 1 em 2023, a aula testa as rotas por dois caminhos: o programa Insomnia e a extensão do Postman para o Visual Studio Code, que pede login. Nos dois, o caminho é o mesmo: montar o método e o endereço, enviar a requisição e conferir a resposta.

Neste vídeo (12 min):

  • 1:31 - Para rodar a API do exemplo, abre um terminal no Visual Studio Code, digita npm install para instalar o que ela precisa e depois npm run dev.
  • 2:57 - Mostra como cada rota é montada no código: uma base guardada numa variável mais uma terminação, o método (GET, POST, DELETE) e o que a API executa quando a requisição chega.
  • 3:44 - No Insomnia, escolhe o tipo de requisição e digita o endereço da API na própria máquina, localhost:3000, com a terminação da rota.
  • 4:36 - A resposta traz a tabela inteira da temporada de 2023 da Fórmula 1, com Max Verstappen em primeiro lugar.
  • 5:04 - O Insomnia mostra também que a API devolveu o código 200 OK.
  • 6:07 - Passa para a rota que devolve um piloto específico a partir do id e cria uma nova requisição com o id no fim do endereço.
  • 7:20 - A resposta traz só os dados do Max Verstappen: Red Bull Racing na temporada de 2023, 575 pontos e o id.
  • 8:22 - Segunda alternativa: procura o Postman na aba de extensões do Visual Studio Code.
  • 9:08 - Ao clicar na extensão, o Postman pede login, que é gratuito e pode ser feito com a conta Google.
  • 9:29 - Cria uma coleção e uma nova requisição GET para localhost:3000/api/v1/drivers/ seguida do id.
  • 10:07 - A resposta chega com os mesmos dados do Max Verstappen, numa aba de teste separada da aba do código.

Trechos do vídeo:

  • Um endpoint é a combinação do endereço com o método HTTP: testá-lo é montar a requisição nesse formato, enviá-la e conferir se a API executa o que você espera que aconteça.
  • Para testar uma rota que busca um registro pelo id, você precisa conhecer esse id antes de montar a requisição; uma saída é pegá-lo na resposta da rota que devolve todos os registros.
  • A extensão do Postman integra o teste ao Visual Studio Code: dá para fazer a requisição e ler a resposta sem sair do programa em que a API está sendo desenvolvida.

Para receber por e-mail o(s) arquivo(s) utilizados na aula, preencha:

Não vamos te encaminhar nenhum tipo de SPAM! A Hashtag Treinamentos é uma empresa preocupada com a proteção de seus dados e realiza o tratamento de acordo com a Lei Geral de Proteção de Dados (Lei n. 13.709/18). Qualquer dúvida, nos contate.

Como Testar APIs de Forma Eficiente – Insomnia e Postman

As APIs (Application Programming Interface – Interface de Programação de Aplicações) são fundamentais para a comunicação entre diferentes sistemas e serviços.

Desenvolver uma API funcional e eficiente, garantindo que todas as suas rotas e endpoints funcionem corretamente, é uma tarefa essencial para qualquer programador.

Por isso, nesta aula, eu vou te mostrar as melhores práticas para o desenvolvimento e teste de APIs, destacando duas ferramentas essenciais que vão te auxiliar muito nesse processo: Insomnia e Postman.

Para testar APIs de forma eficiente, use ferramentas dedicadas como o Insomnia e o Postman. Com elas, você envia requisições (GET, POST, PUT, DELETE), define cabeçalhos e corpo, e visualiza a resposta da API sem precisar de um front-end. Isso agiliza o desenvolvimento e ajuda a encontrar erros antes de integrar a API à aplicação.

Introdução às APIs

Uma API é um conjunto de códigos, regras, protocolos e opções que possibilitam a comunicação entre diferentes aplicações.

Elas podem ser usadas para acessar recursos e funcionalidades de sistemas ou serviços de software, como sistemas operacionais, bancos de dados, serviços web, aplicativos, entre outros.

Através de uma API, um aplicativo pode acessar dados de um servidor. Essa comunicação é feita através de rotas que recebem requisições HTTP, como GET, POST e DELETE, permitindo que os usuários acessem ou enviem dados ao servidor.

Saiba mais em: O que são APIs e WebAPIs – Diferenças e Importância

Configurando o Ambiente e Instalando a API

Antes de começar, certifique-se de ter o Node.js instalado no seu sistema. Além disso, ao longo desta aula, usaremos o VS Code para gerenciar nossa API.

Se você ainda não instalou o Node.js ou o VS Code, veja o passo a passo de como baixar e instalar nas aulas abaixo:

Ícone JavaScriptJavaScript Impressionador

Como usar JavaScript em qualquer empresa e qualquer área, com exemplos totalmente aplicados à realidade do Mercado de Trabalho, seja para se tornar um Desenvolvedor Front End, Backend, Full Stack ou Mobile.

Black Friday · Lote Especial · Lote 1 · Último Lote

De R$ 1.497 56% OFF54% OFF53% OFF

por 12x R$ 6467,5069

Preço do Lote Especial até 13/11, às 23h59Último dia do Lote Especial: o preço vale até hoje, às 23h59Preço do Lote 1 até 20/11, às 23h59Último dia do Lote 1: o preço vale até hoje, às 23h59Preço do Último Lote até 27/11, às 23h59Último dia do Último Lote: o preço vale até hoje, às 23h59

Começar agoraQuero a oferta de Black FridaySeta para a direita
Fundo JavaScriptTelas JavaScript

Além disso, no material disponível para download, você encontrará o código de uma API simples desenvolvida em JavaScript, que estarei utilizando como exemplo nesta aula.

Para utilizar essa API, após fazer o download dela, abra o código no VS Code e, dentro do terminal, execute o comando npm install para instalar todas as dependências necessárias.

comando npm install

Após a instalação ser concluída, use o comando npm run dev para iniciar o servidor da API.

comando npm run dev

Se tudo tiver funcionado corretamente, você verá a mensagem API rodando com sucesso.

Estrutura Básica da API

Nossa API tem várias rotas que respondem a diferentes tipos de requisições HTTP. Cada rota possui um método associado (GET, POST, DELETE), que determina o comportamento da API ao receber uma solicitação.

Essa é uma API que mantém os registros dos pilotos de Fórmula 1. Então, podemos acessar os dados de todos os pilotos e suas pontuações através de uma requisição do tipo GET para a rota /api/v1/drivers.

JavaScript
app.get(baseAPIRoute + '/drivers', (req, res) => {
  res.status(200).send(drivers);
});

Para aprender mais sobre as estruturas de uma API e como construir a sua a partir do zero, confira nosso Minicurso de NodeJS – Backend com JavaScript.

Testando API com Insomnia

Agora que a API está sendo executada, o próximo passo é garantir que todas as rotas estão configuradas e funcionando corretamente. Para isso, uma das ferramentas mais populares para testes de API é o Insomnia.

O Insomnia é um aplicativo que permite fazer requisições HTTP de forma prática e intuitiva. Com ele, você pode testar suas rotas enviando requisições personalizadas e recebendo as respostas da API em tempo real.

Para baixar o Insomnia, basta acessar o site deles e fazer o download gratuito.

Insomnia

Com o Insomnia instalado e a API sendo executada, você pode abrir o aplicativo e, dentro dele, clicar no sinal de mais (+) e depois em HTTP Request.

Criando uma requisição

A partir disso, você pode selecionar o tipo de requisição (GET, POST, DELETE) e configurar o endpoint da API que deseja testar.

Por exemplo, para testar a rota que retorna a classificação dos pilotos de Fórmula 1, basta configurar uma requisição GET para o endereço http://localhost:3000/api/v1/drivers.

testando a requisição

Feito isso, clique em Send e o Insomnia enviará a requisição para a API, retornando a resposta na tela.

Você verá o código de resposta 200, indicando que a requisição foi bem-sucedida, e uma lista com os pilotos e suas pontuações, como Max Verstappen em primeiro lugar.

Visualizando a resposta

O Insomnia facilita a verificação de diferentes rotas e métodos, garantindo que todas as funcionalidades da API estejam funcionando conforme o esperado.

Testando sua API com Postman dentro do VS Code

Outra ferramenta poderosa para testar APIs, e que pode ser uma alternativa ao Insomnia, é o Postman. A vantagem do Postman é que ele pode ser utilizado diretamente dentro do Visual Studio Code por meio de uma extensão.

Testando sua API com Postman dentro do VS Code

Com o Postman, você pode criar requisições HTTP diretamente no editor, sem precisar alternar entre diferentes janelas. Isso permite que você teste sua API enquanto desenvolve, tornando o fluxo de trabalho mais ágil e prático.

Após instalar a extensão, você poderá acessá-la no menu lateral do VS Code. Durante o primeiro acesso, você precisará criar ou fazer login no Postman.

Feito isso, basta clicar em New HTTP Request, selecionar o método desejado e definir a rota da API.

Requisição com Postman

Assim como no Insomnia, você terá as informações sobre a requisição diretamente na tela.

Resposta da requisição postman

A vantagem é que, com essa abordagem, você não precisa trocar de programa para testar sua API, tendo dentro do VS Code a possibilidade de editar e testar a API ao mesmo tempo.

Perguntas frequentes sobre testar APIs

1. Como testar uma API?

Use um cliente de API como Insomnia ou Postman: informe a URL do endpoint, escolha o método (GET, POST, etc.), preencha cabeçalhos e corpo da requisição e envie. A ferramenta mostra a resposta (status e dados), permitindo validar se a API funciona como esperado.

2. O que é o Postman?

É uma das ferramentas mais populares para testar e documentar APIs. Permite montar requisições, organizar coleções, automatizar testes e compartilhar com a equipe, tudo em uma interface visual.

3. Qual a diferença entre Insomnia e Postman?

Os dois testam APIs com recursos parecidos. O Insomnia é mais leve e enxuto, com foco na simplicidade; o Postman é mais completo, com automação de testes, monitoramento e colaboração em equipe. A escolha depende da complexidade do seu fluxo.

4. Preciso saber programar para testar uma API?

Não para o básico. Tanto o Insomnia quanto o Postman permitem montar e enviar requisições pela interface, sem escrever código. Conhecer programação ajuda em testes automatizados e em cenários mais avançados.

Conclusão – Como Testar APIs de Forma Eficiente

Testar APIs é uma etapa fundamental no desenvolvimento de qualquer aplicação web, e ferramentas como o Insomnia e o Postman facilitam a nossa vida como desenvolvedores, permitindo testar e depurar as APIs de maneira eficaz e prática.

Nessa aula, eu te mostrei como instalar e utilizar essas duas ferramentas que irão otimizar o seu tempo e progresso no desenvolvimento de suas APIs, garantindo que elas funcionem corretamente e como esperado.

Se você quiser aprender mais sobre o desenvolvimento de APIs, confira também nossa aula: Conhecendo o ExpressJS – Crie APIs Facilmente com JavaScript

Hashtag Treinamentos

Para acessar publicações de JavaScript, clique aqui!


Quer aprender mais sobre JavaScript com um minicurso básico gratuito?

Posts mais recentes de JavaScript

Posts mais recentes da Hashtag Treinamentos