Como criar uma API RESTful do Node.js. usando Express.js no Ubuntu 16.04 LTS

• Instalando o Postman
• Instalando o Node.js
• Inicializando nosso projeto Node.js.
• Configurando o Express.js
• Iniciando nosso arquivo principal
• Testando nossa API com o Postman
• Rotas da API
• Introdução ao NGINX
• Configurando o NGINX
• Primeira execução com NGINX
• Mantendo nossa API em execução
• Gerenciando nosso aplicativo com o PM2
• Considerações finais

Neste tutorial, você aprenderá como configurar uma API RESTful completa, que atenderá solicitações HTTP usando o Node.js e o Express, ao fazer o proxy reverso com o NGINX, no Ubuntu 16.04 LTS. Nós estaremos utilizando um aplicativo chamado Postman, uma ferramenta de desenvolvimento de API muito conhecida, para testar nossa API e garantir que ela esteja totalmente funcional e funcionando corretamente. O Node.js é uma estrutura JavaScript rápida e multiplataforma, baseada no mecanismo V8 do Chrome. Ele é usado em aplicativos de desktop e servidor e é famoso por seu tratamento de loop de eventos de thread único. Usaremos o Node.js como back-end da nossa API RESTful, junto com o Express.js, nossa estrutura de aplicativos da Web criada para o Node.js. O Express.js é lançado como software livre e aberto. O Express é do lado do servidor, escrito em JavaScript, e foi projetado para criar APIs, o que o torna perfeito para o nosso projeto. Por outro lado, o Postman é um cliente HTTP muito poderoso, com o desenvolvimento da API em mente. Possui todas as ferramentas que você poderia desejar para o desenvolvimento da API.

Instalando o Postman

Primeiro, você quer ir para o site do Postman , baixar e instalar o Postman no seu PC principal (não no seu servidor). Todas as instruções de instalação estarão em seu site.

Instalando o Node.js

Para começar, primeiro precisamos instalar o Node.js para que possamos começar a desenvolver nossa API. Nós estaremos baixando e instalando o Node.js no site oficial.

 curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
 sudo apt-get install -y nodejs

Além disso, você também desejará pegar as ferramentas de compilação necessárias, que serão úteis na compilação de módulos.

sudo apt-get install build-essential

Neste tutorial, usaremos a versão LTS do Node.js, que é a versão 8.9.3.

Inicializando nosso projeto Node.js.

Precisamos inicializar um novo projeto Node.js., que conterá um aplicativo. Para fazer isso, crie um novo diretório.

 mkdir expressapi 

Mude para o novo diretório. Uma vez dentro, execute npm inite conclua todas as solicitações necessárias. Anote o "ponto de entrada" do seu aplicativo: você criará este arquivo mais tarde. Quando terminar, você verá um package.jsonarquivo em seu diretório atual. Ele atua como uma descrição do nosso projeto e lista todas as dependências necessárias para funcionar.

Configurando o Express.js

Agora vamos configurar o Express.js e suas dependências.

npm install express

O processo de instalação será iniciado. Levará alguns minutos para que tudo termine o download.

Iniciando nosso arquivo principal

Em seguida, criaremos nosso principal arquivo inicial para nossa API. Aqui é onde você usará o "ponto de entrada" que você viu no package.jsonarquivo. Para fins deste tutorial, usarei o esquema de nomenclatura padrão index.js,.

touch index.js

Em seguida, abra-o no editor de nano texto.

nano index.js

Em nosso arquivo principal, queremos chamar primeiro todos os nossos pacotes principais e registrar nossas rotas.

var express = require('express');        
var app = express();                 
var bodyParser = require('body-parser');
app.use(bodyParser.urlencoded({ extended: true }));
app.use(bodyParser.json());
var port = process.env.PORT || 8080;  
const router = express.Router();
router.get('/', function(req, res) {
    res.json({ message: 'API is Online!' });   
});

app.use('/api', router);
app.listen(port);
console.log('Listening on port ' + port);

Basicamente, o que estamos fazendo aqui é inicializar nosso aplicativo e configurar um roteador básico para nossa API. Observe que configuramos a porta do aplicativo para 8080. Precisamos desse número para quando configurarmos nossa API RESTful. Agora estamos prontos para prosseguir e testar nossa API.

Testando nossa API com o Postman

No diretório do projeto, execute o seguinte.

node <filename>.js

Isso iniciará a API, onde <filename>está o arquivo inicial especificado no package.jsonarquivo. Em seguida, abra o Postman no seu PC / Mac e clique no botão " New" no canto superior direito e clique em " Request". Quando estiver lá, você verá uma barra que diz " GET" ao lado dela. Aqui vamos inserir nosso URL de solicitação. Basta digitar o seguinte na seção URL de solicitação e clicar em " Send".

`http://your-server-ip:3000/api` 

Você verá " 'API is online'".

Rotas da API

Para lidar com rotas, usaremos o roteador Express. Se você não sabe o que é um roteador, é essencialmente como os pontos de extremidade do aplicativo respondem às solicitações do cliente. Aqui estão as rotas que iremos configurar como exemplo:

• /api/numbers - Mostra todos os números de 1 a 10.

• /api/letters - Mostra todas as letras de AZ.

Agora vamos configurar nossa primeira estrutura de middleware de rota, assim.

router.use(function(req, res, next) {
   console.log('We've got something.');
   next() //calls next middleware in the application.
});

router.route('/numbers/:number').get((req, res) => {
     res.json({result: req.params.number + 1})
});

Neste exemplo, configuramos uma situação em que um usuário pode solicitar a soma de um número + 1, fornecendo a forma da palavra, usando o método GET. Usamos a router.route()função para apontar para qual número queremos enviar como resultado. Os parâmetros são nomeados com um " :" na frente deles. Acessamos esses parâmetros via req.params.

Aqui está um exemplo com letras.

   router.route('/letters/:letter').get((req, res) => {
     res.json({result: req.params.letter.toUpperCase()})
});

Usamos o mesmo método acima, mas enviamos de volta a letra com letras maiúsculas.

Introdução ao NGINX

O NGINX é um software de código aberto bem conhecido usado para exibição na web, proxies reversos, streaming e muito mais. Usaremos o NGINX para fazer o proxy reverso de nossa API, para permitir a execução na porta 80, porque o Node.js não permite conexões em portas inferiores a 1024 sem acesso root. Isso pode ser útil ao vincular seu domínio ao servidor.

Configurando o NGINX

Para começar a instalar o NGINX, você precisará executar o seguinte em seu terminal e aguardar a conclusão da instalação.

sudo apt-get install nginx

Em seguida, queremos criar o arquivo do site que o NGINX usará para reverter o proxy do nosso aplicativo.

sudo nano /etc/nginx/sites-available-api.js

Preencha o arquivo com o seguinte e, em seguida, CTRL+ Opara salvá-lo.

server {
          listen 80;
          location / {
                proxy_set_header X-Real-IP 
                $remote_addr;
                proxy_set_header 
                X-Forwarded-For 
                $proxy_add_x_forwarded_for;
                proxy_set_header Host 
                $http_host;
                proxy_set_header 
                X-NginX-Proxy true; proxy_pass 
                http://127.0.0.1:8080/;
                proxy_redirect off;
                proxy_http_version 1.1;
                proxy_set_header Upgrade 
                $http_upgrade;
                proxy_set_header Connection 
                "upgrade";
                proxy_redirect off;
                proxy_set_header 
               X-Forwarded-Proto $scheme;
       }
}

Usando a mesma porta em que executamos nosso aplicativo anteriormente, estamos dizendo ao Nginx para redirecionar todas as solicitações do nosso endereço IP na porta 80para a API em execução na porta 8080.

Em seguida, ative o proxy reverso vinculando nosso arquivo recém-criado à sites-availablepasta:

sudo ln -s /etc/nginx/sites-available/api /etc/nginx/sites-available

Isso garantirá que o NGINX reverterá o proxy da nossa API.

Primeira execução com NGINX

Depois de concluir nossa configuração do NGINX, iniciaremos o NGINX e, em seguida, iniciaremos nossa API. Primeiro, reinicie o NGINX.

sudo systemctl restart nginx

Em seguida, volte ao diretório da API e inicie-o.

node <filename>.js

O aplicativo será executado, na porta 80. Basta executar o teste de cima com o Postman, para garantir que tudo esteja funcionando corretamente.

Mantendo nossa API em execução

Em um ambiente de produção, você deseja certificar-se de ter um gerenciador de processos para seus aplicativos Node, para garantir que eles permaneçam em execução para sempre em segundo plano. Neste tutorial, usaremos um gerenciador de processos chamado PM2 (Process Manager 2), que é um gerenciador de processos para aplicativos Node.js. que os manterão vivos para sempre com um tempo de inatividade mínimo. O PM2 vem com muitas ferramentas úteis de gerenciamento, como parar, recarregar, pausar e muito mais. Para instalar o PM2, digite o seguinte e aguarde a instalação.

sudo npm install pm2 -g

Depois de instalado, tudo que você precisa fazer é verificar se está no diretório do projeto, digite o seguinte e o aplicativo será iniciado.

pm2 start <filename>.js

Gerenciando nosso aplicativo com o PM2

Como mencionado anteriormente, o PM2 possui algumas ferramentas úteis que você pode usar para gerenciar melhor seu aplicativo.

• pm2 stop- Como o nome sugere, isso permite que você interrompa o aplicativo em execução no momento e interrompa seu processo. Se o seu aplicativo estiver produzindo um resultado inesperado, pará-lo será útil.

• pm2 list- A função de lista permite ver todos os aplicativos em execução no momento via PM2, mapeados por seus nomes. Se você precisar verificar rapidamente o tempo de atividade do seu aplicativo, use esta ferramenta.

• pm2 restart- Se o seu aplicativo congelar por algum motivo e você quiser recarregá-lo, o pm2 restart fará exatamente isso. Isso matará o processo de aplicação e o iniciará novamente, sob um processo diferente.

• pm2 monit- A ferramenta de monitor interno do PM2 permite visualizar um gráfico dos detalhes específicos do seu aplicativo, como o uso da CPU / RAM, em um gráfico fácil de usar no estilo ncurses. Isso é útil se você quiser uma imagem visual da carga do seu aplicativo.

Considerações finais

Agora concluímos nossa tarefa de criar uma API RESTful, utilizando o Node.js, Express e a proxy reversa com o NGINX. Sinta-se livre para expandir este tutorial. Você pode fazer muitas coisas excelentes com sua nova API, como adicionar métodos de autenticação, um banco de dados, melhor tratamento de rotas e erros e muito, muito mais. Se você possui um domínio, com um registro "A" já configurado no seu endereço IP, poderá acessar sua API a partir do seu domínio. Se você quiser saber mais sobre o Express.js, visite o site em http://expressjs.com . Para saber mais sobre o NGINX e o proxy reverso, visite http://nginx.com . Para ler mais sobre o PM2, visite a página em http://pm2.keymetrics.io .