Esta API, desenvolvida utilizando .NET 8,adota os princípios do Domain-Driven Design (DDD) para oferecer uma solução estruturada e eficaz no gerenciamento de despesas pessoais. O principal objetivo é permitir que os usuários registrem suas despesas, detalhando informações como título, data e hora, descrição e tipo de pagamento, com os dados sendo armazenados de forma segura em um banco de dados MySQL.
A arquitetura da API baseia-se em REST, utilizando métodos HTTP padrão para uma comunicação eficiene e simplificada. Além disso, é complementada por uma documentação Swagger, que proporciona uma interface gráfica interativa para que os desenvolvedores possam explorar e testar os endpoints de maneira fácil.
Dentre os pacotes NuGet utilizados, o AutoMapper é o responsável pelo mapeamento entre os objetos de domínio e requisição/resposta, reduzindo a necessidade de código repetitivo e manual. O FluentAssertions é utilizado nos testes de unidade para tornar as verificações mais legíveis, ajudando a escrever testes claros e compreensíveis. Para as validações, o FluentValidation é usado para implementar regras de validação de forma simples e intuitiva nas classes de requisições, mantendo o código limpo e fácil de manter. Por fim, o EntityFramework atua como um ORM (Object-Relational Mapper) que simplifica as interações com o banco de dados, permitindo o uso de objetos .NET para manipular dados diretamente, sem a necessidade de lidar com consultas SQL.
- Domain-Driven Design (DDD): Estrutura modular que facilita o entendimento e a manutenção do domínio da aplicação.
- Testes de Unidade: Testes abrangentes com FluentAssertions para garantir a funcionalidade e a qualidade.
- Geração de Relatórios: Capacidade de exportar relatório detalhados para PDF e Excel, oferencendo uma análise visual e efecaz das despesas.
- RESTful API com Documentação Swagger: Interface documentada que facilita a integração e o teste por parte dos desenvolvedores.
Para obter um cópia local funcionando, siga estes passos simples:
- Visual Studio version 2022+ ou Visual Studio Code
- Windows 10+ ou Linux/MacOS com .NET SDK instalado
- MySQL Server
-
Clone o repositório:
git clone https://github.com/devfabiorm/CashFlow.git
-
Preencha as informações no arquivo
appsettings.Development.json. -
Execute a API e aproveite seu teste :)