ResiliaBooks API

Sobre o projeto

Trata-se do desenvolvimento de uma API para uma livraria.Ela possui todas as rotas básicas do CRUD e faz parte do projeto final do quarto módulo do curso de Desenvolvimento Web da Resilia.

Foram criadas quatro entidades conforme demonstra o diagrama a seguir:

Dependências utilizadas para o desenvolvimento

• 
• 
• 
• 
• 

Instalações necessárias

O projeto deve ser executado localmente. Recomendamos a instalação do Banco de dados MySQL e do Insomnia em sua máquina. Você pode fazer o download de ambos clicando nos links a seguir:

• MySQL
• Insomnia

Clone este repositório em sua máquina

$ git clone https://github.com/elderschmoeller/Projeto-Modulo-4.git

Como rodar

1. Instale NodeJS em seu computador;

2. Crie um banco de dados no sistema SQL de sua preferência: MySQL, Postegree, SQL Server, SQLITE;

3. Crie uma tabela com o nome resiliabooks no banco de sua preferência;

4. Instale via terminal utilizando os seguintes comandos:

 npm init
 npm install -g
 npm install express 
 npm install mysql2 
 npm install sequelize sequelize-cli path 
 npm install cors
 npm install --save-dev nodemon

Em seguida, com o projeto já rodando em sua máquina, abra o Insomnia para testar as rotas GET, POST, PUT e DELETE. Apenas a título de exemplo, vamos fazer um passo a passo a seguir utilizando a entidade Clientes.

Usando o GET

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

Usando o POST

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

   {
       "nome_completo": "",
       "email":"",
       "idade": "",
       "cpf: "",
       "endereco": "",
       "telefone": ""
   }

Usando o PUT

• /clientes/:id: Atualiza o nome, email, idade cpf, endereco, telefone do cliente com a id informada no banco de dados. Também é possível atualizar apenas uma dessas informações substindo o :id pelo atributo específico que deseja alterar. Caso não exista um cliente com a respectiva com a id é retornado um erro com status 404. É necessário enviar no body da requisição um JSON:

    {
        "nome_completo": "",
        "email":"",
        "idade": "",
        "cpf: "",
        "endereco": "",
        "telefone": ""
    }

Usando o DELETE

• /clientes/:id: Remove o cliente com a id informada do banco de dados. Caso não exista um cliente com a respectiva id é retornado um erro com status 404.

Equipe

• Daniel Duarte
• Elder Schmöeller
• Sophia Blazizza
• Vitor Rodrigues Germano