Conhecendo o ExpressJS – Crie APIs Facilmente com JavaScript

Você já ouviu falar do framework ExpressJS? Com ele, é possível criar APIs de forma rápida e prática usando JavaScript.

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.

Conhecendo o ExpressJS – Crie APIs Facilmente com JavaScript

O ExpressJS é um framework minimalista para Node.js que simplifica o desenvolvimento de servidores web e APIs em JavaScript.

Nesta aula, vamos explorar um exemplo prático de controle de estoque para mostrar como você pode criar sua própria API com facilidade.

Apesar de ser um exemplo simples, este projeto vai te ajudar a entender o processo de criação de uma API e como fazer a comunicação entre ela e o código principal.

Além disso, veremos como usar o Insomnia para realizar requisições e testar a API que criarmos.

Introdução ao ExpressJS

O ExpressJS é amplamente utilizado para a criação de APIs de forma simples e objetiva.

Ele abstrai boa parte da complexidade na criação de servidores HTTP e oferece um processo intuitivo para lidar com rotas, middlewares e respostas HTTP.

Para mais detalhes sobre APIs, recomendo conferir nossa aula: O que são APIs e WebAPIs – Diferenças e Importância

Preparativos para o Projeto

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 criar, editar e gerenciar nosso código.

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:

• Como instalar o NodeJS
• Como instalar o VS Code

Configuração Inicial do Projeto

Com o Node.js instalado, o próximo passo é iniciar o projeto e configurar o ambiente de desenvolvimento.

Para começar, crie uma pasta para armazenar os arquivos do projeto e abra-a no VS Code.

Dentro do editor de códigos, abra um novo terminal e execute o comando npm init -y para gerar o arquivo package.json.

Este arquivo contém as configurações básicas do projeto, como dependências e scripts.

Em seguida, adicione a propriedade “type”: “module” ao package.json.

{
  "name": "express",
  "version": "1.0.0",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "description": "",
  "type": "module",
}

Isso nos permite trabalhar com múltiplos arquivos de código de maneira modular, seguindo o sistema de módulos ES, que possibilita o uso de import e export para organizar seu código em diferentes arquivos.

Agora, vamos instalar o ExpressJS rodando o comando npm install express no terminal.

Isso vai criar a pasta node_modules, onde ficarão as dependências do projeto necessárias para o funcionamento do Express.

Criando API com ExpressJS – Sistema de Estoque

Com as configurações prontas, podemos começar o desenvolvimento da API. Crie um arquivo chamado estoque.js, onde implementaremos a lógica da API.

Dentro desse arquivo, defina um array de objetos representando os itens do estoque. Cada objeto terá informações como id e nome do produto.

const estoque = [
  { id: 1, nome: "mesa" },
  { id: 2, nome: "cadeira" },
  { id: 3, nome: "gaveteiro" },
];

Esse array simula o estoque de uma loja de móveis, mas a lógica pode ser facilmente adaptada para outros tipos de negócios.

Feito isso, vamos exportar o array para usá-lo em outros arquivos.

const estoque = [
  { id: 1, nome: "mesa" },
  { id: 2, nome: "cadeira" },
  { id: 3, nome: "gaveteiro" },
];

export default estoque;

Aplicação Principal da API

Com o array de produtos criado, o próximo passo é desenvolver a aplicação principal, onde definiremos as rotas para acessar os dados da API.

Vamos construir essa aplicação dentro do arquivo app.js, que é um nome comum para o arquivo principal em projetos JavaScript, mas você pode escolher outro nome, se preferir.

Dentro desse arquivo, vamos importar o array estoque e também a funcionalidade express da biblioteca Express.

import estoque from "./estoque.js";
import express from "express";

Em seguida, criaremos um objeto app a partir da função express. Esse objeto será o núcleo da nossa aplicação, onde controlaremos as rotas e funcionalidades da API.

import estoque from "./estoque.js";
import express from "express";

const app = express();

Para permitir que outros sistemas se comuniquem com a API, utilizaremos o método listen, definindo a porta 3000. Isso significa que o servidor estará disponível localmente nessa porta.

import estoque from "./estoque.js";
import express from "express";

const app = express();

app.listen(3000);

Métodos HTTP – Definindo Rotas na API

Quando um usuário acessa uma API, ele realiza uma requisição, que pode ser de diferentes tipos, dependendo da ação desejada.

No contexto da web, os métodos HTTP mais comuns são:

• GET para obter uma informação do servidor.
• POST para enviar uma informação ao servidor.
• PUT atualizar uma informação do servidor.
• DELETE apagar uma informação do servidor.

Se quiser entender melhor sobre a comunicação na web e os diferentes métodos HTTP, acesse nossa aula: Comunicação na Internet – Todo Desenvolvedor Web Deve Saber

Sabendo disso, vamos criar uma rota GET chamada /produtos, que retornará a lista de produtos em estoque.

Para isso, usamos o método get(), que define o comportamento da API quando a rota é acessada. O servidor responde com o código de status 200 (requisição bem-sucedida) e envia (send()) o array estoque como resposta.

Essa operação é realizada por meio de uma função que recebe dois parâmetros: req (requisição) e res (resposta). Essa função será chamada sempre que o usuário acessar o caminho /produtos da nossa API.

import estoque from "./estoque.js";
import express from "express";

const app = express();

app.get("/produtos", (requisicao, resposta) => {
  resposta.status(200).send(estoque);
});

app.listen(3000);

Executando e Testando a API

Com isso, já temos a estrutura básica da nossa API funcional. Para rodar o servidor, basta executar o seguinte comando no terminal: node ./app.js.

A API estará disponível localmente na porta 3000, e você poderá acessá-la através do endereço: http://localhost:3000/produtos

Também podemos testar a API utilizando o Insomnia, uma ferramenta gratuita para fazer requisições HTTP.

Com ela, é possível enviar diferentes tipos de requisições para a API e verificar as respostas, incluindo o código de status HTTP.

Para utilizar essa ferramenta é bastante simples, com a API sendo executada, abra o Insomnia, clique no sinal de mais (+) e depois em HTTP Request.

Isso criará uma nova requisição (New Request). Dentro dela, podemos definir o tipo de requisição que estamos fazendo e para qual endereço queremos fazê-la.

Nesse caso será uma requisição do tipo GET para o http://localhost:3000/produtos.

Ao realizar a requisição, você verá o array de produtos sendo retornado pela API, além do código de status da resposta.

Com isso, concluímos o desenvolvimento da nossa API de controle de estoque. Embora seja uma estrutura simples, ela permite que você compreenda como funciona o ExpressJS e como podemos utilizá-lo para criar APIs de forma eficiente.

Se você deseja aprender a criar um sistema completo de backend com Node.js e ExpressJS, incluindo a configuração e o desenvolvimento do servidor da sua WebAPI, confira o nosso Minicurso de NodeJS – Backend com JavaScript.

Conclusão – Conhecendo o ExpressJS – Crie APIs Facilmente com JavaScript

Nesta aula, você conheceu o ExpressJS e aprendeu a criar APIs usando esse framework com JavaScript.

O ExpressJS é uma excelente escolha para quem deseja criar APIs de forma rápida e eficiente. Sua simplicidade, combinada com sua flexibilidade, faz dele uma ferramenta poderosa para desenvolvedores backend.

Seja para pequenos projetos, como o que criamos aqui, ou grandes sistemas, o Express pode ser utilizado para construir APIs escaláveis e de fácil manutenção.

Quer aprender mais sobre JavaScript e se destacar no mercado? Confira o nosso Curso Completo JavaScript Impressionador e dê o próximo passo na sua jornada como desenvolvedor!

Diego Monutti

Expert em conteúdos da Hashtag Treinamentos. Auxilia na criação de conteúdos de variados temas voltados para aqueles que acompanham nossos canais.