Livraria API REST 📚

Aplicação back-end desenvolvida pelo Squad 3 para a finalização do módulo 4 do curso de Desenvolvimento Web FullStack da Resilia Educação. 💛

• Descrição
• Tabela de Conteúdo
• Rotas da API
• Livros
• Usuários
• Funcionários
• Estoque
• Como executar o projeto?
• Requisitos
• Instalação das dependências
• Desenvolvedores

Rotas da API

As rotas são acessada através do http://localhost:3000/_nome-rota_

Livros 📚

Métodos	Rotas	Descrição
GET	/livros	Retorna tabela inteira de livros
GET	/livros/id	Retorna livro especificado por id
POST	/livros	Cria um novo livro na tabela
PATCH	/livros/id	Atualiza um livro especificado por id
DELETE	/livros/id	Deleta um livro especificado por id

Acessar livros pela rota: http://localhost:3000/livros

Modelo do corpo da requisição:

{
    "titulo": "título do livro",
    "descricao": "descrição do livro",
    "categoria": "categoria do livro",
    "url_image": "URL da imagem do livro",
    "preco": "preço do livro",
    "total_paginas": "quantidade de páginas do livro",
    "ano_publicacao": "ano da publicação do livro",
    "autor": "autor do livro"
}

Exemplo:

{
    "titulo": "Código limpo: Habilidades práticas do Agile Software",
    "descricao": "Mesmo um código ruim pode funcionar. Mas se ele não for limpo, pode acabar com uma empresa de desenvolvimento. Perdem-se a cada ano [...]",
    "categoria": "Programação",
    "url_image": "https://images-na.ssl-images-amazon.com/images/I/4153E2zZmTS._SX350_BO1,204,203,200_.jpg",
    "preco": "69.99",
    "total_paginas": "425",
    "ano_publicacao": "2009",
    "autor": "Robert C. Martin"
}

Usuários 🙂

Métodos	Rotas	Descrição
GET	/usuarios	Retorna tabela inteira de usuarios
GET	/usuarios/id	Retorna usuario especificado por id
POST	/usuarios/registrar	Cria um novo usuario na tabela
POST	/usuarios/login	Para fazer o login do usuário
PATCH	/usuarios/id	Atualiza um usuario especificado por id
DELETE	/usuarios/id	Deleta um usuario especificado por id

Acessar usuarios pela rota: http://localhost:3000/usuarios

Modelo do corpo da requisição:

{
    "CPF": "cpf do usuário",
    "nome": "nome do usuário",
    "email": "email do usuário",
    "senha": "senha do usuário"
}

Exemplo:

{
    "CPF": "12345678900",
    "nome": "Maria Augusta",
    "email": "maria.augusta@gmail.com",
    "senha": "123456"
}

Funcionários 💼

Métodos	Rotas	Descrição
GET	/funcionarios	Retorna tabela inteira de funcionarios
GET	/funcionarios/id	Retorna funcionario especificado por id
POST	/funcionarios	Cria um novo funcionario na tabela
PATCH	/funcionarios/id	Atualiza um funcionario especificado por id
DELETE	/funcionarios/id	Deleta um funcionario especificado por id

Acessar pela rota: http://localhost:3000/funcionarios

Modelo do corpo da requisição:

{
    "CPF": "cpf do funcionário",
    "nome": "nome do funcionário",
    "cargo": "cargo do funcionário",
    "salario": "salário do funcionário",
    "statusFuncionario": "informa se está trabalhando ou de férias"
}

Exemplo:

{
    "CPF": "12345678900",
    "nome": "João da Silva",
    "cargo": "Gerente de vendas",
    "salário: "2.500",
    "statusFuncionario": "Férias"
}

Estoque 📦

Métodos	Rotas	Descrição
GET	/estoque	Retorna tabela inteira de estoque
GET	/estoque/id	Retorna estoque o especificado por id
POST	/estoque	Cria um novo estoque na tabela
PATCH	/estoque/id	Atualiza um estoque especificado por id
DELETE	/estoque/id	Deleta um estoque especificado por id

Acessar pela rota: http://localhost:3000/estoque

Modelo do corpo da requisição:

{
    "nome_fornecedor": "nome do fornecedor",
    "CNPJ": "CNPJ do fornecedor",
    "qnt_livros": "quantidade de livros",
    "lote": "número do lote",
    "nome_obra": "nome da obra",
    "preco_lote": "preço do lote"
}

Exemplo:

{
    "nome_fornecedor": "Alta Books",
    "CNPJ": "12345678900",
    "qnt_livros": "186",
    "lote": "02154878787841IF",
    "nome_obra": "Código limpo: Habilidades práticas do agile software",
    "preco_lote": "8.000,00"
}

Como executar o projeto? 🤔

1.0 Requisitos para rodar localmente 💻

Ferramentas necessárias para executar a API localmente:

• VsCode ou outro editor de preferência
• Node.js instalado na máquina
• Postman, Insomnia ou semelhante.

1.1 Instalando as dependências 🛠️

1.1.1 Clone este repositório localmente em sua máquina

git clone git@github.com:thainarapenha/LivrariaAPI.git

1.1.2 Entre na pasta do projeto

cd LivrariaAPI

1.1.3 Execute o seguinte comando para instalar as dependências do projeto:

npm install

1.1.4 Execute o seguinte script para rodar o servidor:

npm run dev

1.1.5 Abra o Insomnia e execute a rotas especificadas 💻👌

Desenvolvedores(as) 👨‍💻