Criar uma API RESTful com Node.js | Tutorial Express.js

Introdução

Neste projeto, você aprenderá como desenvolver uma API RESTful usando Node.js e Express.js. O projeto envolve a criação de um sistema simples de gerenciamento de usuários, onde você pode recuperar uma lista de usuários.

👀 Visualização

curl http://localhost:8080/list
## Output:
## {"userlist":[{"id":"1","username":"zhangsan","password":"123456"},{"id":"2","username":"lilei","password":"456"},{"id":"3","username":"hanmeimei","password":"123"}]}

🎯 Tarefas

Neste projeto, você aprenderá:

Como configurar um projeto Node.js e instalar dependências
Como criar um servidor Express.js básico
Como implementar um endpoint GET para recuperar uma lista de usuários de um arquivo JSON
Como testar a API usando cURL

🏆 Conquistas

Após concluir este projeto, você será capaz de:

Entender os fundamentos do desenvolvimento de API RESTful
Configurar um projeto Node.js e instalar as dependências necessárias
Criar um servidor Express.js simples
Implementar um endpoint GET para recuperar dados de um arquivo JSON
Testar a API usando cURL

Configurar o Projeto

Nesta etapa, você configurará o projeto e instalará as dependências necessárias.

O código inicial para esta questão já foi fornecido. Abra o ambiente de codificação, e a estrutura de diretórios é a seguinte:

├── index.js
├── users.json
├── package.json
├── package-lock.json

Em seguida, baixe as dependências usando o comando npm install no terminal, aguarde a conclusão do download das dependências e, em seguida, inicie o projeto usando o comando npm run dev.

✨ Verificar Solução e Praticar

Implementar o Endpoint GET /list

Nesta etapa, você implementará o endpoint GET /list para exibir a lista de usuários.

Abra o arquivo index.js no diretório do projeto.
Localize a seção TODO no arquivo e adicione o seguinte código para implementar o endpoint GET /list:

//TODO
app.get("/list", function (req, res) {
  fs.readFile(
    path.resolve(__dirname, "./users.json"),
    "utf8",
    function (err, data) {
      data = JSON.parse(data);
      res.json(data);
    }
  );
});

Este código lê o arquivo users.json, analisa os dados JSON e os envia como resposta.

Salve o arquivo index.js.

✨ Verificar Solução e Praticar

Testar o Endpoint GET /list

Nesta etapa, você testará o endpoint GET /list para garantir que ele esteja funcionando corretamente.

Abra um novo terminal no ambiente do laboratório.
Use o comando curl para enviar uma requisição GET para o endpoint /list:

curl http://localhost:8080/list

Você deve ver a seguinte saída, que é o dado JSON do arquivo users.json:

{"userlist":[{"id":"1","username":"zhangsan","password":"123456"},{"id":"2","username":"lilei","password":"456"},{"id":"3","username":"hanmeimei","password":"123"}]}

Se você vir esta saída, o endpoint GET /list está funcionando corretamente.

Parabéns! Você concluiu o projeto e implementou o endpoint GET /list para exibir a lista de usuários.

✨ Verificar Solução e Praticar