Sobre o Projeto

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, valor e tipo de pagamento, com os dados sendo armazenados de forma segura em um banco de dados PostreSql hospedado no portal render.

A arquitetura da API baseia-se em REST, utilizando métodos HTTP padrão para uma comunicação eficiente e simplificada. Além disso, é complementada por uma documentação Swagger, que proporciona uma interface gráfica interativa para que os desenolvedores possam explorar e testar os endpoints de maneira fácil.

Dentre os pacotes NuGet utilizados, o AutoMapper é o responsável pelo mapeamento entre objetos de domínio e requisição/resposta, reduzindo a necessidade de código repetitivo e manual. O FluentAssertions é utilizados nos testes de unidade para tornar as verificação 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.

Features

• 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 do código.
• Geração de Relatórios: Capacidade de exportar relatórios detalhados para PDF e Excel, oferencendo uma análise visual e eficaz das despesas.
• RESTful API com Documentação Swagger: Interface documentada que facilita a integração e o teste por parte dos desenvolvedores.
• Conceitos de SOLID: Estrutura do projeto construída seguindo princípios do SOLID afim de facilitar a manutenção e legibilidade dos código.

Construído com

Getting Started

Para obter uma cópia local funcionando, siga estes passos simples.

Requisitos

• Visual Studio Versão 2022+ ou Visual Studio Code
• Windows 10+ ou Linux/MacOs com .NET SDK instalado
• PostgreSql instalado localmente (opcional)

Instalação

1. Clone o repositório:

   git clone https://github.com/henrikesilva/CashFlow.git

2. Preencha as informações no arquivo appsettings.Development.json.

   • Caso opte por utilizar uma instância diferente de banco de dados

3. Execute a API e aproveite o seu teste :)

Teste em Produção

Caso você opte, pode efetuar os testes na API publicada em produção a partir da branch main através desse link