Desenvolvimento de uma api do tipo Rest em NodeJs utilizando a framework express.

Descrição da aplicação:

A aplicação é um ambiente back-end que gerencia e automatiza uma agenda de atendimentos, para qualquer tipo de serviço. Para isso foi utilizado o banco de dados relacional MySQL, onde o exemplo para as variaveis de ambiente que definem a conexão se encontra aqui, foi utilizado o padrão do tipo REST e como organização conceitos de MVC.

Ferramentas utilizadas:

Para o desenvolvimento como já mencionado foi utilizado JavaScript com NodeJS como linguagem da aplicação e o Express como framework, além do banco de dados relacional MySQL hospedado pela ferramenta de cloud Heroku.

Dependencias necessárias:

"dependencies": {
    "consign": "^0.1.6",
    "express": "^4.17.1",
    "moment": "^2.29.1",
    "mysql2": "^2.3.2"
}

As dependencias podem ser encontradas neste arquivo do qual o trecho acima foi extraído para instalar basta rodar o comando abaixo selecionando e copiando o mesmo com as teclas "Ctrl + c" e em seguida colar no terminal com as telas "Ctrl + Shift + v" o comando abaixo já irá fazer o clone deste repositório e instalar as dependencias necessárias.

git clone https://github.com/LeoCosta-dev/apiRestNodeJsAgendaDeAtendimentos.git && cd apiRestNodeJsAgendaDeAtendimentos && npm install consign && npm install express && npm install moment && npm install mysql2

Dependencias de desenvolvimento:

"devDependencies": {
    "dotenv": "^10.0.0",
    "nodemon": "^2.0.14"
  }

Em outra parte do arquivo de configuração é possível encontrar o código acima que foi extraído do mesmo, essas são as dependencias necessárias para o ambiente de desenvolvimento da aplicação, caso deseje instalar utilize os comandos abaixo em seu terminal logo após o comando das dependencias obrigatórias.

npm install dotenv && npm install nodemon

Inicialização da aplicação via terminal:

Para inicio da aplicação basta abrir o terminal na pasta do projeto ou executar o código abaixo na sequencia dos códigos acima caso seja a primeira execução, esteja na sequencia dos comandos acima e com o seu banco de dados já conectado seja ele local ou em nuvem.

npm start

Observação importante:

A versão NodeJs utilizada para desenvolvimento é a 14.x LTS, logo é necessário intalação de versão igual ou superior para a perfeita execução da mesma.

Rotas da api:

No presente momento temos apenas a rota "/atendimentos" onde podemos fazer alguns métodos interessantes.

Ver todos os atendimentos:

Utilizar o método HTTP Get no caminho "url da api" + /atendimentos

Buscar atendimento por id:

Utilizar o método HTTP Get no caminho "url da api" + /atendimentos/id

Buscar atendimento por ciente:

Utilizar o método HTTP Get no caminho "url da api" + /atendimentos/cliente

Adicionar atendimento:

Utilizar o método HTTP Post no caminho "url da api" + /atendimentos com todos os dados necessários para o seu banco de dados. Nesta por exemplo que se trata de um petshop os campos são: id, cliente, pet, servico, data, dataCriacao, status e observacoes.

Modificar um atendimento já existente:

Utilizar o método HTTP Patch no caminho "url da api" + /atendimentos/:id passando os valores que deseja alterar especificando seus devidos campos.

Deletar um atendimento:

Utilizar o método HTTP Delete no caminho "url da api" + /atendimentos/:id.