https://github.com/pedroh183/sistemadetransferenciaapi
Api que simula um sistema de transferência entre duas entidades da aplicação.
https://github.com/pedroh183/sistemadetransferenciaapi
api clean-architecture flask python
Last synced: 4 months ago
JSON representation
Api que simula um sistema de transferência entre duas entidades da aplicação.
- Host: GitHub
- URL: https://github.com/pedroh183/sistemadetransferenciaapi
- Owner: PedroH183
- Created: 2024-02-03T21:13:09.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-21T18:25:45.000Z (over 1 year ago)
- Last Synced: 2025-05-09T01:49:56.681Z (6 months ago)
- Topics: api, clean-architecture, flask, python
- Language: Python
- Homepage:
- Size: 52.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Sistema de Transferência
- Esse projeto foi contruído com base no desafio do [**PicPay**](https://github.com/PicPay/picpay-desafio-backend)
## Setup da aplicação
- > Clone o repositório
- > Edite as variáveis de conexão com o banco de dados no arquivo `settings.py` e certifique-se que ele existe.
- > Na raiz do projeto rode o comando `docker compose up` esse comando criará todo o ambiente necessário para a aplicação e após a aplicação estará rodando.
## Estrututra de Pastas
```bash
├── app
│ ├── Adapter
│ ├── Controller
│ ├── Domain
│ │ ├── Transferencia
│ │ └── Usuarios
│ ├── ReturnClass
│ └── Services
│── settings.py
│── run.py
└── venv
```
## Api Endpoints
A Api dispõem dos seguintes endpoints :
### Api Usuario Comum
```
POST /usuario/add - Create a new commom user
GET /usuario/all - Retrieve all commoms users
GET /usuario/view/{id} - Updates a commom user
DELETE /usuario/delete/{id} - Delete a commom user
POST /usuario/transferirDinheiro - transferir
```
### Body
```bash
## data body of a commom user
{
"saldo" : 123
"senha" : "123",
"cpf" : "111.114.574-25",
"email" : "pedro@gmail.com",
"nome_completo" : "Pedro Henrique",
}
```
### Api Lojista
```bash
POST /lojista/add - Create a new shopkeeper
GET /lojista/all - Retrieve all shopkeepers
GET /lojista/view/{id} - Updates a shopkeeper
DELETE /lojista/delete/{id} - Delete a shopkeeper
```
### Body
```bash
{
"saldo" : 123,
"senha" : "1234",
"nome_completo" : "Pedro Henrique",
"cnpj" : "31.231.231/2001-99",
"email" : "pedro@email.com"
}
```