gabrielss187 / python-api-v1

Python-API-V1

Sobre o projeto

API Documentação: Python-API-V1-DOC

OBS: API construida para fins de meus estudos com Python.

A API: Python-API-V1, consiste em ser uma api rest facíl de sí usar. Para gerenciar qualquer tipo de produtos. CRUD completo, onde você pode criar, buscar, editar e deletar produtos e clientes criados. Também é possível que os clientes cadastrados / registrados no sistema, contratarem os produtos disponíveis, caso ele esteja autenticado.

Rotas

Client

• 1 - GET-CLIENT-BY-TOKEN : GET http://127.0.0.1:5000/clients
• 2 - GET-ALL-CLIENTS : GET http://127.0.0.1:5000/clients/all
• 3 - CLIENT-CONTRACT-PRODUCT: GET http://127.0.0.1:5000/clients/contract_product/:id-product
• 4 - CREATE-CLIENT: POST http://127.0.0.1:5000/clients/create
• 5 - CLIENT-LOGIN: POST http://127.0.0.1:5000/clients/login

Product

• 1 - GET-ALL-PRODUCTS : GET http://127.0.0.1:5000/products
• 2 - REGISTER-PRODUCT : POST http://127.0.0.1:5000/products/register
• 3 - EDIT-PRODUCT : PUT http://127.0.0.1:5000/products/edit/:id-product
• 4 - DELETE-PRODUCT : DELETE http://127.0.0.1:5000/products/delete/:id-product

Vídeo Usando á API

20230516_004445.2.mp4

Modelagem Conceitual de Dados

Competências

• Boas Práticas
• Clean Code

Tecnologias utilizadas

Banco de dados

• MySQL

ORM

• SQLAlchemy

Outras Tecnologias

• Python
• alembic
• Flask
• Flask-Cors
• Flask-JWT-Extended
• Flask-SQLAlchemy
• mysqlclient
• python-dotenv

Como executar o projeto na sua máquina 💻💻

Pré-requisitos: Python / MySQL URL

É preencher as variáveis de ambiente do .env

===============================================================================

Passo 1

• Clone o repositório

# Clonar
git clone https://github.com/GabrielSS187/Python-API-V1.git

# Entre na pasta 
cd Python-API-V1

Passo 2

• Crie seu ambiente virtual

# Criar ambiente virtual
python -m venv env

# Ativar ambiente virtual Linux ou Mac
source env/bin/activate

# Ativar ambiente virtual Windows
env\Scripts\activate

Passo 3

• Instale todas as dependências

# Instalar
pip install -r ./requirements.txt

• Depois de terminado de instalar todas as dependências, de um reload / restart no seu editor de códigos.

Passo 4

Preencher as variáveis de ambiente no arquivo .env e depois cole á sua URL de conexão com o MySQL no arquivo alembic.ini 👇👇👇

• 1 - .env : Tire o nome .exemple do arquivo .env.exemple e preencha todas as variáveis de ambiente necessárias.
• 2 - alembic.ini : Entre nesse arquivo e navegue até o nome sqlalchemy.url = depois do sinal de igual, cole sua URL de
• conexão com o MySQL.

Passo 5

• Depois de ter feito tudo isso, rode o comando para subir todas as migrações para seu banco de dados

alembic upgrade head

Passo 6 - Final

• Por fim, entre na pasta infra, e rode o comando para iniciar o servidor

# Entrar na pasta infra
cd infra

# Iniciar o servidor
flask run

=================================================================================

Caso nada de errado o projeto vai esta rodando na rota: http://127.0.0.1:5000

Autor

Gabriel Silva Souza

https://www.linkedin.com/in/gabriel-silva-souza-developer