API-livraria-cliente📚

Projeto de encerramento do módulo 4 da Resilia Educação.
O projeto consiste no desenvolvimento de uma API para livraria, que possui todas as rotas básicas do CRUD.
As condições principais para a entrega do projeto foram:

o uso do padrão REST, com os verbos referentes ao protocolo HTTP;

o uso do padrão DAO ou de ORM para interagir com o banco de dados - optamos por utilizar o ORM Sequelize e o banco de dados SQLite.;

organização do desenvolvimento com padrão MVC.

Dependências do projeto:

Para inicializar o projeto precisamos do Node.JS instalado na máquina, entre nesse link e baixe a versão LTS referente ao seu sistema operacional. Foi utilizado a versão 16.14.0 no projeto.

Quando terminar a instalação, confirme se ocorreu tudo bem abrindo o powershell/terminal do seu computador e digite o comando abaixo, se aparecer a versão que você instalou, então ele já está pronto para ser usado:

node -v

Clone este repositório em sua máquina:

$ git clone https://github.com/priscilarossetto/API-livraria-cliente.git

Será necessário instalar as dependências do projeto. Abra o terminal dentro da pasta do projeto e execute o seguinte:

npm install
npm install express
npm install sequelize
npm install sqlite3

Inicie o projeto:

npm run dev

ou

npm start

Criando uma conexão no Beekeeper

Caso queira observar as alterações no banco de dados, a aplicação open-source Beekeeper é uma opção.

Disponível para download em: https://www.beekeeperstudio.io/

Após a instalação:

Select a connection type: sqlite

database file: Procurar a pasta do projeto e seleciona o arquivo dev.sqlite

Nomear e salvar

Rodar o servidor com npm run dev e recarregar no Beekeeper: a(s) entidade(s) deve(m) aparecer lá

Rotas do projeto:

A partir de uma ferramenta para consulta de requisições, no projeto utilizamos o Insomnia para testar as rotas GET, POST, PUT e DELETE.
Verifique antes se o seu servidor está rodando, se não, não será possível testar esse e outros métodos.
Passo a passo utilizando a entidade Cliente.

Create - POST:

/client

Cria um registro de cliente no banco de dados. É necessário enviar um body no formato JSON com as informações a seguir:

  {
    "nome" : "",
    "sobrenome" : "",
    "cpf" : "",
    "email" : "",
    "endereco" : "",
    "telefone" : ""
  }

Read - GET:

/client

Retorna as informações de todos os clientes salvos no banco de dados.

/client/:id

Retorna as informações correspondente a id informada como parâmetro.

Update - PUT:

/client/:id

Atualiza o nome, sobrenome, cpf, email, endereco e telefone do cliente com a id informada no banco de dados. Caso não exista um cliente com a respectiva id é retornado um erro com status 400. É necessário enviar no body da requisição um JSON:

  {
    "nome" : "",
    "sobrenome" : "",
    "cpf" : "",
    "email" : "",
    "endereco" : "",
    "telefone" : ""
  }

Delete - DELETE:

/client/:id

Remove um registro de cliente com a id informada do banco de dados. Caso não exista um cliente com a respectiva id é retornado um erro com status 400.

Tecnologias utilizadas

VSCode

JavaScript

NodeJS

Express

Sequelize ORM

Beekeeper

Insomnia