10.8. Criando uma API REST básica com NodeJS e ExpressJS: Tratamento de erros

10.8. Criando uma API REST básica com NodeJS e ExpressJS: Tratamento de erros

NodeJS e ExpressJS são duas ferramentas poderosas que você pode usar para criar APIs REST. Uma API REST, ou Representational State Transfer, é um estilo de arquitetura de software que usa um conjunto de protocolos e padrões para criar aplicativos web. Nesta seção, vamos aprender como criar uma API REST básica com NodeJS e ExpressJS e como lidar com erros.

Configurando o ambiente

Antes de começarmos, precisamos ter certeza de que temos NodeJS e npm (Node Package Manager) instalados em nosso sistema. Se você ainda não os tem, pode baixá-los do site oficial do NodeJS. Após a instalação, você pode verificar se eles estão instalados corretamente executando os seguintes comandos no terminal:

$ node -v
$ npm -v

Em seguida, precisamos instalar o ExpressJS, que é um framework web para NodeJS. Você pode instalar o ExpressJS usando o npm com o seguinte comando:

$ npm install express

Criando a API REST

Primeiro, vamos criar um novo arquivo chamado 'app.js'. Este será o nosso arquivo principal onde vamos configurar a nossa API REST. No arquivo 'app.js', vamos começar importando o ExpressJS:

const express = require('express');

Em seguida, vamos criar uma nova instância do Express:

const app = express();

Agora, vamos definir algumas rotas para a nossa API. Por exemplo, vamos criar uma rota GET para '/users' que retorna uma lista de usuários:

app.get('/users', (req, res) => {
  res.json({ users: ['John', 'Jane', 'Bob'] });
});

Finalmente, vamos fazer a nossa aplicação ouvir a porta 3000:

app.listen(3000, () => {
  console.log('Server is running on port 3000');
});

Tratamento de erros

O tratamento de erros é uma parte crucial de qualquer aplicação. No ExpressJS, você pode tratar erros usando middlewares de erro. Um middleware de erro é uma função que tem quatro argumentos: (err, req, res, next).

Você pode definir um middleware de erro da seguinte maneira:

app.use((err, req, res, next) => {
  console.error(err.stack);
  res.status(500).send('Something broke!');
});

Este middleware de erro irá capturar qualquer erro que ocorrer na aplicação e irá registrar a pilha de erro no console, e então enviar uma resposta com o status 500 e a mensagem 'Something broke!'.

É importante notar que o middleware de erro deve ser definido depois de todas as outras rotas e middlewares, porque ele só irá capturar erros que ocorrerem no middleware e nas rotas que forem definidas antes dele.

Além disso, você pode criar middlewares de erro personalizados para tratar diferentes tipos de erros de maneiras diferentes. Por exemplo, você pode criar um middleware de erro para tratar erros de validação e outro para tratar erros de autenticação.

Conclusão

Neste capítulo, aprendemos como criar uma API REST básica com NodeJS e ExpressJS e como tratar erros. O ExpressJS torna muito fácil criar APIs REST e oferece muitas funcionalidades úteis, como middlewares de erro, que nos permitem tratar erros de maneira eficaz.

No próximo capítulo, vamos aprender como adicionar autenticação à nossa API e como proteger as nossas rotas com JWT (JSON Web Tokens).

Próxima página do Ebook Gratuito:

74Criando uma API REST básica com NodeJS e ExpressJS: Autenticação e autorização

4 minutos