Finances-API: Uma API RESTful para controle financeiro

Tecnologias utilizadas

Descrição

Essa é uma API RESTful desenvolvida como desafio para praticar e aprender sobre backend, através do Challenge Backend da Alura. Essa API é responsável por realizar controle financeiro de forma simples.

Confira o Deploy da aplicação

HEROKU

Desafios sugeridos

• API com rotas implementadas seguindo as boas práticas do modelo REST
• Validações feitas conforme as regras de negócio
• Implementação de base de dados para persistência das informações
• Serviço de autenticação/autorização para restringir acesso às informações

Funcionalidades já implementadas

✔️ Capaz de adicionar, consultar, atualizar e deletar Despesas.
✔️ Capaz de adicionar, consultar, atualizar e deletar Receitas.
✔️ Gera um resumo mensal com o total das receitas, despesas, saldo final e o total gasto por categoria.
✔️ Deploy da API no Heroku.

O que ainda será desenvolvido?

📝 Adicionar o controle de acesso (autenticação e autorização)
📝 Melhorar a documentação da API

Rodando a aplicação ▶️

Requisitos

• Java 11
• Docker
• Maven
• Git

Passo 1. Clonar o repositório

Rodar o comando abaixo no Git Bash para clonar o repositório:

git clone [email protected]:nevitoniuri/finances-api.git

Passo 2. Subir o container do Docker para criar o banco de dados MySQL

No diretório raiz do projeto, execute o comando:

docker-compose up -d

Passo 3. Acessar a documentação da API

http://localhost:8080/swagger-ui.html

Além disso, também disponibilizei a Collection do Postman para testes

• Collection Postman