Criando uma API utilizando Nodejs

Há muito tempo não escrevo um artigo neste Blog. Hoje resolvi compartilhar um pouco de conhecimento sobre criação de API's utilizando Nodejs.

Criei um projeto público no github que já deixa montado uma estrutura básica para criar uma API em nodejs utilizando-se do framework restify. Você pode acessá-lo aqui.

Você pode realizar um fork do projeto ou baixá-lo para testar. Certifique-se de rodar o comando node install dentro da pasta do projeto após baixá-lo.

A estrutura de pastas que utilizei é a seguinte:

- app
    - config/
    - controllers/
    - middlewares/
    - services/
    - index.js

O ponto de entrada da aplicação é o index.js. Este arquivo já está previamente configurado e não é necessário alterá-lo. 

Dentro da pasta config haverá um arquivo de configuração de ambiente (env.config.js) e um para a configuração de rotas (routes.config.js).

• env.config.js: por fins didáticos há neste arquivo uma configuração hardcoded de porta, hostname e dados para logs. Em um outro artigo posso abordar sobre outras abordagens para carregar a configuração do aplicativo.
• routes.config.js: Já vi muita gente que deixa esse arquivo numa pasta de routes ou mesmo em config. Eu particularmente gosto de deixar dentro da pasta config. Nele você pode configurar as rotas de sua API. Segue um exemplo de post, put, patch e delete:
  • server.post('/algum-endpoint', [
       ApplicationMiddleware.doSomeMiddleware,
       ApplicationController.post
    ]);
  • server.put('/algum-endpoint', [
      
       ApplicationController.put
    ]);
  • server.patch('/algum-endpoint', [
       ApplicationController.patch
    ]);
  • server.del('/algum-endpoint', [
       ApplicationController.del
    ]);

Dentro do código há um exemplo na rota get('/') que utiliza os arquivos dentro de controllers, middlewares e services.

Para testar o projeto basta executar o seguinte comando na raíz do projeto:

• node app/index

Dado isto, pode-se testar a rota de get('/') e ver que está tudo funcionando. Ex:

• usando curl: curl localhost:7001
• abrindo o seu browser e inserindo a url: localhost:7001
• usando outro aplicativo, como o Postman e executando um get para localhost:7001

E com isso temos uma estrutura básica e funcional de uma API em nodejs.

Leu aqui até agora e ainda não baixou o projeto? Baixe ele aqui e acelere o desenvolvimento de sua API.