Blog

Postado em em 9 de outubro de 2024

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!

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.

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:

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.

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.

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