/LABinventory-BackEnd

BackEnd da Squad 1 no projeto LABinventory

Primary LanguagePython

⚙️ LABinventory API

API desenvolvida em Flask para o projeto final do Curso DEVInHouse. A API foi feita para as requisições do frontend de uma Single Page Application desenvolvida em Vue.js

⚙️ Instalação

Setup do Projeto

# Clone este repositório
$ git clone https://github.com/DEVin-ConectaNuvem/M3P2-LABinventory-BackEnd-Squad1

Instale as dependências

poetry install

Compilação para desenvolvimento

poetry run flask run

🔑 ENDPOINT: (POST) /users/create

Endpoint para a criação de conta.

Body params: 
{
    "email": "", 
    "password": ""
}

🔑 ENDPOINT: (POST) /users/auth/google

Esse endpoint ao realizar a requisição retorna a URL para realizar o seu login com a conta Google no APP.

🔑 ENDPOINT: (GET) /users/callback

Esse endpoint é o callback do Google onde pega as informações do usuario e o retorna ao Frontend

🔑 ENDPOINT: (POST) /users/login

Endpoint para o login de conta.

Body params: 
{
    "email": "", 
    "password": ""
}

📚 ENDPOINT: (POST) /inventory/create

Endpoint para a criação de item.

Body params: 
{
    "codPatrimonio": "",
    "title": "",
    "description": "",
    "category": "",
    "value": 0,
    "brand": "",
    "model": ""
}

📚 ENDPOINT: (GET) /inventory/

Endpoint para o retorno de dados dos itens.

📚 ENDPOINT: (GET) /inventory/

Endpoint para pesquisa de item pelo ID.

Query params exemplo: 
example: http://localhost:5000/inventory/2

📚 ENDPOINT: (GET) /inventory/list

Endpoint para o retorno de dados dos itens na tela de empréstimo.

📚 ENDPOINT: (PATCH) /inventory/update

Endpoint para atualizar um item.

Body params: 
{
  id: ""
  dataset: {
       title: ""
   }
}

📚 ENDPOINT: (DELETE) /inventory/delete

Endpoint para deletar um item.

Body params: 
{
  id: ""
}

📚 ENDPOINT: (GET) /inventory/analytics

Endpoint para retornar os dados do inventario.

🧍 ENDPOINT: (POST) /employees/create

Endpoint para a criação de conta.

Body params: 
{
    "name": "",
    "email": "",
    "phone": "",
    "position": "",
    "gender": "",
    "zipcode": "",
    "birthDay": "",
    "city": "",
    "state": "",
    "neighborhood": "",
    "street": "",
    "houseNumber": 0,
    "complement": "",
    "reference": ""
}

🧍 ENDPOINT: (GET) /employees/

Endpoint para o retorno de dados dos colaboradores.

🧍 ENDPOINT: (GET) /employees/

Endpoint para pesquisa de colaborador pelo ID.

Query params exemplo: 
example: http://localhost:5000/employees/2

🧍 ENDPOINT: (PATCH) /employees/update

Endpoint para atualizar um item.

Body params: 
{
  id: ""
  dataset: {
       name: ""
   }
}

🧍 ENDPOINT: (DELETE) /employees/delete

Endpoint para deletar um colaborador.

Body params: 
{
  id: ""
}

👋 Desenvolvedores

Breno Martins

 Luiz Gustavo Seemann

 Eduardo Martins Ribeiro
Rafael Telles Carneiro

 Bruno V

 Thiago William

🤝 Agradecimentos:

A realização deste projeto apenas foi possível em razão do excelente ensino disponibilizado por toda a equipe DEVInHouse e ConectaNuvem!