estudos-node-js

anotações sobre node.js, API REST express e rotas

servidor node.js

cria pasta com o diretório src para organização de arquivos e abertura da pasta raíz no vscode:

mkdir nome-pasta nome-pasta/src && cd nome-pasta && code .

inicia pacote node.js

npm init -y

realiza instalação do express

npm i express@4.17 --define versão a partir de orientações para o projeto

adicional: instalação de linter nas configurações da trybe

npm i eslint@6.8 eslint-config-trybe-backend@1.0 -D

cria arquivos de configuração de lint e git

touch .eslintignore .eslintrc.json .gitignore

observações sobre arquivos criados:

.eslintignore: orienta ao ESLint que ignore arquivos e diretórios específicos;
.eslintrc.json: determina sobrescrição de regras do ESLint;

.eslintignore

adiciona pasta node_modules/

.eslint.json

preenchimento do arquivo com o seguinte código, seguindo orientações da trybe:

{

  "env": {

    "es2020": true

  },

  "extends": "trybe-backend",

  "rules": {

    "sonarjs/no-duplicate-string": ["error", 5]

  }

}

.gitignore

adiciona pasta node_modules/

framework express

cria os arquivos app.js e server.js na pasta src

app.js

const express = require('express');

const app = express();

app.use(express.json()); // para receber o body dentro do objeto require

module.exports = app;

realiza a importação do pacote do express, inicia o mesmo no aplicativo a partir da função express() e atribui ela a variável app, realizando assim sua exportação para reutilização em diferentes arquivos como o server.js

server.js

const app = require('./app');

app.listen(3001, () => console.log('server running on port 3001'));

o start da aplicação será provido pelo trecho de código com a função .listen(), que recebe dois parâmetros:

o port, onde no código é passado 3001 mas pode ser qualquer número não utilizado acima de 1023;
uma função, no código acima foi passado apenas um console.log() para informar que o servidor está rodando

configurações do package.json na aba scripts

"start": "node src/server.js",

"dev": "nodemon src/server.js",

"lint": "eslint --no-inline-config --no-error-on-unmatched-pattern -c .eslintrc.json ."

o comando start é reconfigurado para a aplicação iniciar pelo server.js, já configurado como servidor inicial;
o comando dev orienta a dependência de desenvolvedor do nodemon para inicializar também pelo server.js, auxiliando na reinicialização automática da aplicação cada vez que um arquivo for alterado e salvo;
o comando lint adiciona os comandos de verificação do eslint

obs: realizar instalação do pacote nodemon através do comando npm i nodemon@2.0 -D --a tag -D adiciona o pacote como devDependencies, já que a utilidade do mesmo não é necessário na produção, apenas no desenvolvimento

rotas (caminhos, paths, endpoints)

a anatomia de uma URL consiste em protocolo, domínio e rota:

+ https:// | protocolo
+ github.com | domínio
+ /login | rota

adiciona a seguinte linha de código no app.js:

app.get('/', (req, res) => res.status(200).json({ message: 'Olá Mundo!' }));

ao acessar a port pelo navegador através do localhost, é possível visualizar a mensagem

a) função .get(): utilizada para pedir algum dado, recebendo dois parâmetros:

'/': rota desejada, nesse caso é a raíz (página inicial)
(req, res) => {}: espera uma função de callback, que pode receber de dois a quatro parâmetros, sendo eles:
- req: REQUEST, por meio dela recebemos os dados (envio por query, params e body);
- res: RESPONSE, por meio dela respondemos o que nos é solicitado;
- next: [add];
- err: [add];

b) boas práticas consistem no envio de um status code, no caso da função .status(200). os status são importantes para identificação da resposta das requisições. acessar documentação do MDN sobre status code

método http

GET - obtêm/recupera dados
POST - insere dados
PUT - atualização completa
PATCH - atualização parcial
DELETE - exclui dados

famílias de status code

100 - respostas de informação
200 - respostas de sucesso
300 - redirecionamento
400 - erro do cliente
500 - erro do servidor

envio de dados para o servidor (query, params, body)

envio por consulta

req.query
o envio de dados por string query é construído através da estrutura /rota?variavel=valor&variavel2=valor2, onde o ? indica que serão passados dados para a rota e nesse caso há duas querys sendo enviadas, onde o & pode ser utilizado para agregar múltiplas variáveis na linha); largamente utilizadas ao enviar dados via GET; normalmente é utilizado no contexto de consultas SQL

envio por parâmetro

req.params
o envio de dados por parâmetros é construído através da estrutura /rota/:variavel, onde o /: indica que serão passados dados para a rota; ao passarmos um valor seguindo a estrutura da rota, ele será armazenado dentro da variável determinada como parâmetro; ao adicionar /rota/12345, '12345' será armazenado como valor em variavel

envio por corpo

req.body
utiliza o próprio corpo da requisição para enviar os dados de forma encapsulada, sem exibir na URL; normalmente no método GET se recebe dados no corpo, não se envia (as solicitações ao servidor são feitas no header); POST e PUT são utilizados para enviar dados para o servidor através do corpo da requisição; visto que a leitura do corpo envolve processos assíncronos, é possível utilizar ferramentas definidas no express para acessar com facilidade esse conteúdo do corpo no código (por exemplo utilizando console.log(req.body)):

app.use(express.text());

exemplo de código endpoint

const express = require('express);
const { readMissionsData } = require('./utils/fsUtils');

const app = express();

app.get('/missions', async (request, response) => {
  const missions = await readMissionsData();
  
  return response.status(200).json({ missions });
}

module.exports = app;

miranda-almeida / estudos-node-js