https://github.com/marcos-monte/sispar-backend
API desenvolvida com Flask e MySQL, responsável pelo gerenciamento de colaboradores e reembolsos no sistema SISPAR.
https://github.com/marcos-monte/sispar-backend
flasgger flask flask-cors mysql python rest-api sqalchemy swagger
Last synced: 2 months ago
JSON representation
API desenvolvida com Flask e MySQL, responsável pelo gerenciamento de colaboradores e reembolsos no sistema SISPAR.
- Host: GitHub
- URL: https://github.com/marcos-monte/sispar-backend
- Owner: Marcos-Monte
- Created: 2025-05-06T10:24:50.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-22T14:53:56.000Z (about 1 year ago)
- Last Synced: 2025-05-22T15:51:04.445Z (about 1 year ago)
- Topics: flasgger, flask, flask-cors, mysql, python, rest-api, sqalchemy, swagger
- Language: Python
- Homepage: https://sispar-backend.onrender.com/apidocs/
- Size: 398 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 📌 sispar-backend
API desenvolvida com **Flask** e **MySQL**, responsável pelo gerenciamento de **colaboradores** e **reembolsos** no sistema SISPAR. Esta documentação orienta como clonar, instalar e executar o projeto, além de apresentar as principais rotas disponíveis.
## ✅ Tecnologias Utilizadas
- Flask
- Flask-SQLAlchemy
- MySQL + mysqlclient
- JWT (com Flask-Bcrypt)
- Flasgger (documentação Swagger)
- Flask-CORS
- Python-dotenv
- Gunicorn (para deploy)
- Pytest + pytest-flask (testes)
## 📦 Clonando e Instalando
```bash
# Clone o repositório
git clone https://github.com/Marcos-Monte/sispar-backend.git
# Acesse a pasta do projeto
cd sispar-backend
# Crie e ative um ambiente virtual (opcional, mas recomendado)
python -m venv venv
source venv/bin/activate # Linux/Mac
venv\Scripts\activate # Windows
# Instale as dependências
pip install -r requirements.txt
```
## ▶️ Como Executar o Projeto
```bash
# Execute o projeto
python run.py
```
O servidor será iniciado em `http://localhost:5000/`.
## 🔐 Variáveis de Ambiente
Crie um arquivo `.env` na raiz do projeto com as seguintes variáveis (exemplo):
```
FLASK_ENV=development
DATABASE_URL=mysql://usuario:senha@localhost/nome_do_banco
```
## 🔗 Rotas Principais
* Documentação (Flasgger) em: `http://localhost:5000/apidocs/`
### 📂 Colaborador
| Método | Rota | Descrição |
|--------|---------------------------------------|-----------------------------------------|
| GET | `/colaborador/todos-colaboradores` | Lista todos os colaboradores |
| GET | `/colaborador/buscar/` | Lista o colaborador pelo email |
| POST | `/colaborador/cadastrar` | Cadastra um novo colaborador |
| POST | `/colaborador/login` | Login de colaborador |
| PUT | `/colaborador/atualizar/` | Atualiza os dados de um colaborador |
| DELETE | `/colaborador/deletar/` | Deleta um colaborador |
### 💰 Reembolso
| Método | Rota | Descrição |
|--------|------------------------------------------|--------------------------------------------|
| GET | `/reembolso/reembolsos` | Lista todos os reembolsos |
| GET | `/reembolso/` | Busca reembolso pelo número de prestação |
| POST | `/reembolso/solicitacao` | Solicita um novo reembolso |
| PUT | `/reembolso/atualizar/` | Atualiza os dados de um reembolso |
| DELETE | `/reembolso/deletar/` | Deleta reembolso pelo número de prestação |
## 🧾 Estrutura de Pastas (resumo)
```
📦 sispar-backend/
┣ 📂src/
┃ ┣ 📂controllers/
┃ ┣ 📂models/
┃ ┣ 📂docs/
┃ ┣ 📂security/
┃ ┗ 📂services/
┃ ┗ 📂tests/
┣ 📂venv/
┣ .gitignore
┣ config.py
┣ run.py
┣ requirements.txt
┗ .env
```
## 🛠 Testes
Execute os testes automatizados com:
```bash
pytest src/tests/test_app.py
```
## 👨💻 Autor
Desenvolvido por [Marcos Monte](https://github.com/Marcos-Monte)