Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lucasmoraist/bank-simplified
Bank-Simplified é uma API para transferência de dinheiro entre carteiras, com funcionalidades de autenticação, autorização de transações e notificações. O sistema integra serviços externos para validação de pagamentos e oferece uma documentação via Swagger para facilitar o uso.
https://github.com/lucasmoraist/bank-simplified
api-rest docker junit mock payment-service postgresql spring-boot
Last synced: 1 day ago
JSON representation
Bank-Simplified é uma API para transferência de dinheiro entre carteiras, com funcionalidades de autenticação, autorização de transações e notificações. O sistema integra serviços externos para validação de pagamentos e oferece uma documentação via Swagger para facilitar o uso.
- Host: GitHub
- URL: https://github.com/lucasmoraist/bank-simplified
- Owner: lucasmoraist
- Created: 2024-09-05T11:29:43.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-10-27T14:33:22.000Z (18 days ago)
- Last Synced: 2024-10-27T16:36:35.054Z (18 days ago)
- Topics: api-rest, docker, junit, mock, payment-service, postgresql, spring-boot
- Language: Java
- Homepage:
- Size: 92.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# bank-simplified
## Descrição
Este projeto é um sistema de transferência de dinheiro, que permite aos usuários transferirem
valores entre carteiras. Ele implementa funcionalidades de autenticação, autorização de transações e notificação.
## Funcionalidades
1. **Criação de Usuário**
- Registro de novos usuários, incluindo comerciantes e usuários comuns.
````json
{
"fullName": "Exemplo de Usuário",
"cpf": "12345678900",
"email": "[email protected]",
"password": "Senha123",
"userType": "COMMON"
}
````
2. **Depósito em Carteira**
- Permite que os usuários depositem um valor em suas carteiras.
````json
{
"amount": 100.00
}
````
3. **Transferência entre Carteiras**
- Transferência de valores entre usuários, com verificação de saldo e autorização externa.
````json
{
"payerId": 1,
"payeeId": 2,
"amount": 100.00
}
````
4. **Comunicação com Serviço Externo**
- Integração com um serviço externo para autorização de transações financeiras.
5. **Notificação de Transações**
- Envio de notificações aos usuários após a conclusão de transferências.
6. **Documentação da API**
- Link para acessar a documentação na máquina -> http://localhost:8080/
## Instruções de Instalação
### Pré-requisitos
- Java 17 ou superior
- Maven 3.2.5 ou superior
- Docker
### Etapas
1. Clone o repositório na sua máquina
````bash
git clone https://github.com/lucasmoraist/bank-simplified.git
````
2. Acesse o diretório do projeto
````bash
cd bank-simplified
````
3. Suba o container do banco de dados com Docker Compose
````bash
docker-compose up -d
````
## Instruções de Uso
- Utilize uma ferramenta como Postman ou Insomnia para testar os endpoints da API.
- Importe o arquivo de requisições disponível no diretório ./collection para facilitar os testes.
- É possível acessar a documentação da API na máquina local através do link http://localhost:8080/ e testar as requisições diretamente no Swagger.
## Contatos
