How practika2024/backend_api works
Project Type and Purpose
• This is a back-end API built on ASP .NET Core (C#) using a classic layered architecture (API, Application, Domain, DataAccess).
• Its purpose is to manage users, containers, container histories, products, product types, reminders, and reminder types. It includes authentication, authorization, email verification, image uploading, and pagination.
File Structure
• Top-level solution (.sln) with “src” and “tests” folders.
• “src/Api”: ASP .NET Core Web API project (Controllers, DTOs, MappingProfiles, Modules, Program.cs, configuration files, Dockerfile).
• “src/Application”: business logic via Commands, Behaviours, Interfaces, Services (EmailService, HashPasswordService, ImageService, PaginationService, ReminderService, JwtTokenService).
• “src/Domain”: pure domain entities and models.
• “src/DataAccessLayer”: EF Core context, Migrations, Entities, Configurations, Repositories, MappingProfiles.
• “tests”: Integration tests for API controllers and common test helpers/data.
README
a. Main Components
• API Layer
– ASP .NET Core Web API (Controllers, DTOs, Error Handlers, DI Modules)
• Application Layer
– Command/Query Handlers, Validators (FluentValidation), Business Services (Email/Hashing/Image/Token/Pagination/Reminder)
• Domain Layer
– Core domain models and interfaces/abstractions
• DataAccess Layer
– EF Core DbContext, Repositories, Mappings, Migrations
• Database
– Relational database (e.g., SQL Server or Postgres)
• Test Harness
– Integration tests against in-memory or test DB
b. Relationships & Interactions
1. HTTP Request → API Controllers
2. Controllers use injected Application interfaces (IUserProvider, ICommandHandler, IQueries)
3. Application layer orchestrates domain models and calls DataAccessLayer repositories via interfaces
4. DataAccessLayer translates to SQL and reads/writes to Database
5. Services in Application (EmailService, JwtTokenService, etc.) are invoked by commands/handlers
6. Responses bubble back through API (mapped via AutoMapper) to client
c. Architectural Patterns & Principles
• Layered (Clean Architecture) separation: keep UI (API) separate from business rules (Application), from data concerns (DataAccess).
• Dependency Inversion: API → Application → Domain; DataAccess implements Domain/Application interfaces.
• CQRS-like Command/Query segregation in Application layer.
• Repository pattern in DataAccess for persistence abstraction.
• Middleware for cross-cutting concerns (error handling, user validation).
d. Key Technologies & Frameworks
• ASP .NET Core Web API
• Entity Framework Core (DbContext, Migrations)
• AutoMapper (MappingProfiles across layers)
• FluentValidation (Validators in Application)
• Docker / docker-compose for containerization
• xUnit (.NET) and custom Test Common libraries for integration testing