10.4. Criando uma API REST básica com NodeJS e ExpressJS: Definição das rotas

Página 69

A criação de uma API REST básica com NodeJS e ExpressJS é um processo que envolve várias etapas. Uma das etapas mais importantes é a definição das rotas, que permite que os usuários interajam com sua API de maneiras diferentes. Neste artigo, discutiremos como definir rotas em sua API usando NodeJS e ExpressJS.

Para começar, é importante entender o que é uma rota. Em termos simples, uma rota é um caminho ou uma URL que os usuários podem acessar para interagir com sua API. Por exemplo, se você tiver uma API que gerencia uma lista de tarefas, pode ter rotas como '/tarefas' para obter todas as tarefas, '/tarefas/:id' para obter uma tarefa específica, '/tarefas' para criar uma nova tarefa, e assim por diante.

Para definir rotas em sua API, você precisa do ExpressJS, um framework para NodeJS que simplifica a criação de APIs. Para instalar o ExpressJS, você pode usar o npm (Node Package Manager), que é uma ferramenta que permite instalar pacotes NodeJS. Você pode instalar o ExpressJS com o seguinte comando:

npm install express

Depois de instalar o ExpressJS, você pode começar a definir suas rotas. Para fazer isso, primeiro você precisa criar uma instância do Express e depois usar os métodos fornecidos por essa instância para definir suas rotas. Aqui está um exemplo:

const express = require('express');
const app = express();

app.get('/tarefas', (req, res) => {
  // Código para obter todas as tarefas
});

app.get('/tarefas/:id', (req, res) => {
  // Código para obter uma tarefa específica
});

app.post('/tarefas', (req, res) => {
  // Código para criar uma nova tarefa
});

app.listen(3000, () => {
  console.log('API rodando na porta 3000');
});

Como você pode ver, o Express fornece métodos como 'get', 'post', 'put' e 'delete' que correspondem aos verbos HTTP que os usuários podem usar para interagir com sua API. Cada método aceita uma URL (ou rota) e uma função de callback que será chamada quando a rota for acessada.

A função de callback recebe dois argumentos: 'req' e 'res'. 'req' é um objeto que contém informações sobre a solicitação HTTP feita pelo usuário, como os parâmetros da URL, os dados enviados no corpo da solicitação, os cabeçalhos da solicitação, etc. 'res' é um objeto que você pode usar para enviar uma resposta ao usuário.

Por exemplo, se você quiser enviar uma lista de tarefas ao usuário quando ele acessar a rota '/tarefas', pode fazer algo assim:

app.get('/tarefas', (req, res) => {
  const tarefas = [
    { id: 1, nome: 'Fazer compras' },
    { id: 2, nome: 'Estudar para a prova' },
    // ...
  ];

  res.json(tarefas);
});

No exemplo acima, 'res.json' é um método que converte o array 'tarefas' em uma string JSON e a envia ao usuário como resposta.

Definir rotas em sua API é uma parte crucial do processo de criação de uma API com NodeJS e ExpressJS. Com as rotas definidas, os usuários podem interagir com sua API de várias maneiras, obtendo dados, enviando dados, atualizando dados e excluindo dados. Ao definir suas rotas, lembre-se de pensar cuidadosamente sobre quais rotas você precisa e quais dados você precisa enviar e receber em cada rota.

Next page of the Free Ebook:

7010.5. Criando uma API REST básica com NodeJS e ExpressJS: Criação dos controladores