# mtnyrgn/netcorewebapibestpractices architecture

> Architecture diagram of the GitHub repository mtnyrgn/netcorewebapibestpractices, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-13). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/mtnyrgn/netcorewebapibestpractices
- Repository: https://github.com/mtnyrgn/netcorewebapibestpractices

## Overview

##### Project Type and Purpose
- This is a .NET Core Web API template using a classic layered architecture (Core → Data → Service → API)
- Supports both SQL (via Entity Framework Core) and MongoDB storage
- Demonstrates best practices (Repository, Unit of Work, DTOs, Filters, AutoMapper, global exception handling, Swagger)

##### File Structure
Top-level projects/modules:
- NetCoreBestPractices.API
– Controllers (Category, Person, Product)
– DTOs (CategoryDto, ProductDto, PersonDto, ErrorDto)
– Filters (Validation, NotFound, AuditLog)
– Extensions (CustomExceptionHandler)
– Mapping (AutoMapper profile)
– Settings (MongoDbSettings)
– Startup, Program, appsettings.json
- NetCoreBestPractices.Core
– Domain models (Entities, BaseDocument for Mongo)
– Interfaces (IRepository, IMongoRepository, IService, IUnitOfWork, etc.)
– DTO definitions are in API layer, so Core only holds domain and contracts
- NetCoreBestPractices.Data
– EF Core AppDbContext, entity configurations, migrations, seeds
– Repository implementations (generic SQL Repository, MongoRepository, CategoryRepository, ProductRepository)
– UnitOfWork implementation
- NetCoreBestPractices.Service
– Business logic implementations (CategoryService, ProductService, MongoService, etc.)
- NetCoreBestPractices.Logging
– Shared logging utilities (used across layers if plugged in via DI)
- NetCoreBestPractices.Test
– Unit tests (xUnit or similar)

##### README Insights
- Layer order: Core → Data → Service → API
- API handles HTTP, DTO mapping, filters, Swagger
- Core holds contracts & models
- Data holds persistence implementations
- Service holds domain/business logic
- Test for verification

##### Main Components and Interactions
a. Components:
- Client (Swagger UI / HTTP Client)
- API Layer
- Controllers
- Filters & Middleware (Exception Handler, Validation, Audit Log)
- AutoMapper
- Service Layer
- Domain services (IService implementations)
- Data Layer
- UnitOfWork
- SQL Repositories (EF Core)
- MongoDB Repositories
- AppDbContext & MongoDB Driver
- Core Layer
- Domain Entities + Contracts (interfaces)
- External Systems
- SQL Server (or chosen RDBMS)
- MongoDB instance
- Cross-Cutting Concern
- Logging module (NetCoreBestPractices.Logging)
- DI Container (built into Startup)

b. Relationships & Data Flows:
1. Client → API.Controller (HTTP request)
2. Controller → Service (via injected IService)
3. Service → UnitOfWork / Repository (SQL or Mongo)
4. Repository → Database (SQL Server or MongoDB)
5. Response bubbles back up: DB → Repository → Service → Controller → Client
6. Filters/Middleware intercept at API boundary (exception handling, validation, audit logging)
7. AutoMapper transforms between Entities ↔ DTOs in Controllers

##### Architectural Patterns & Principles
- Layered (Onion) Architecture
- Repository & Unit of Work (Data layer)
- Dependency Injection (built into .NET Core)
- DTOs & AutoMapper (separate API contracts from domain)
- Middleware/Filters for cross-cutting concerns
- Configuration via appsettings.json / IOptions<T> pattern

##### Relevant Technologies & Frameworks
- .NET Core Web API
- Entity Framework Core
- MongoDB.Driver
- AutoMapper
- Swagger (Swashbuckle)
- xUnit / NUnit for testing
- Microsoft.Extensions.DependencyInjection / Options
- Custom Filters & Middleware

## Diagram (Mermaid)

```mermaid
flowchart TB
    classDef api fill:#B3CDE3,stroke:#000
    classDef service fill:#C7E9C0,stroke:#000
    classDef data fill:#FEC8A8,stroke:#000
    classDef core fill:#D3D3D3,stroke:#000
    classDef external fill:#A9A9A9,stroke:#000
    classDef cross fill:#F4A6A6,stroke:#000

    Client["Client (Swagger UI / HTTP Client)"]:::external

    subgraph "API Layer"
        direction TB
        ValidationFilter["ValidationFilter"]:::cross
        NotFoundFilter["NotFoundFilter"]:::cross
        AuditLogFilter["AuditLogFilter"]:::cross
        CustomExceptionHandler["CustomExceptionHandler"]:::cross

        CategoryController["CategoryController"]:::api
        PersonController["PersonController"]:::api
        ProductController["ProductController"]:::api

        CategoryDTO["CategoryDto / CategoryWithProductDto"]:::api
        ProductDTO["ProductDto / ProductWithCategoryDto"]:::api
        PersonDTO["PersonDto"]:::api
        ErrorDTO["ErrorDto"]:::api

        AutoMapper["AutoMapper (MapProfile)"]:::api

        Startup["Startup.cs"]:::api
        Program["Program.cs"]:::api

        ValidationFilter --> CategoryController
        ValidationFilter --> PersonController
        ValidationFilter --> ProductController
        NotFoundFilter --> CategoryController
        AuditLogFilter --> CategoryController
        CustomExceptionHandler --> CategoryController

        CategoryController -->|uses| CategoryDTO
        PersonController -->|uses| PersonDTO
        ProductController -->|uses| ProductDTO
        CategoryController -->|handles errors| ErrorDTO

        AutoMapper --> CategoryController
        AutoMapper --> ProductController
        AutoMapper --> PersonController

        Startup --> ValidationFilter
        Startup --> NotFoundFilter
        Startup --> AuditLogFilter
        Startup --> CustomExceptionHandler
        Startup --> AutoMapper
        Startup --> CategoryController
        Startup --> PersonController
        Startup --> ProductController
        Startup --> Program
    end

    subgraph "Service Layer"
        direction TB
        Services["CategoryService / ProductService / MongoService"]:::service
    end

    subgraph "Data Layer"
        direction TB
        UnitOfWork["UnitOfWork"]:::data
        subgraph "Repositories"
            direction TB
            SQLRepo["Generic SQL Repository / CategoryRepository / ProductRepository"]:::data
            MongoRepo["MongoRepository"]:::data
        end
        UnitOfWork --> SQLRepo
        UnitOfWork --> MongoRepo
    end

    subgraph "Core Layer"
        direction TB
        Domain["Entities & BaseDocument"]:::core
        Contracts["IRepository / IMongoRepository / IService / IUnitOfWork / etc."]:::core
    end

    subgraph "Databases"
        direction TB
        SQLServer["SQL Server"]:::external
        MongoDB["MongoDB"]:::external
    end

    Logging["NetCoreBestPractices.Logging"]:::cross

    Client -->|HTTP Request| ValidationFilter
    CategoryController -->|IService<Category>| Services
    PersonController -->|IService<Person>| Services
    ProductController -->|IService<Product>| Services

    Services -->|IUnitOfWork / IRepository| UnitOfWork
    SQLRepo -->|EF Core| SQLServer
    MongoRepo -->|MongoDB.Driver| MongoDB

    Logging -.-> CategoryController
    Logging -.-> Services
    Logging -.-> UnitOfWork
    Logging -.-> Domain
    Logging -.-> SQLRepo

    click CategoryController "https://github.com/mtnyrgn/netcorewebapibestpractices/blob/main/NetCoreBestPractices/NetCoreBestPractices.API/Controllers/CategoryController.cs"
    click PersonController "https://github.com/mtnyrgn/netcorewebapibestpractices/blob/main/NetCoreBestPractices/NetCoreBestPractices.API/Controllers/PersonController.cs"
    click ProductController "https://github.com/mtnyrgn/netcorewebapibestpractices/blob/main/NetCoreBestPractices/NetCoreBestPractices.API/Controllers/ProductController.cs"
    click ValidationFilter "https://github.com/mtnyrgn/netcorewebapibestpractices/blob/main/NetCoreBestPractices/NetCoreBestPractices.API/Filters/ValidationFilter.cs"
    click NotFoundFilter "https://github.com/mtnyrgn/netcorewebapibestpractices/blob/main/NetCoreBestPractices/NetCoreBestPractices.API/Filters/NotFoundFilter.cs"
    click AuditLogFilter "https://github.com/mtnyrgn/netcorewebapibestpractices/blob/main/NetCoreBestPractices/NetCoreBestPractices.API/Filters/AuditLogFilter.cs"
    click CustomExceptionHandler "https://github.com/mtnyrgn/netcorewebapibestpractices/blob/main/NetCoreBestPractices/NetCoreBestPractices.API/Extensions/CustomExceptionHandler.cs"
    click AutoMapper "https://github.com/mtnyrgn/netcorewebapibestpractices/blob/main/NetCoreBestPractices/NetCoreBestPractices.API/Mapping/MapProfile.cs"
    click Startup "https://github.com/mtnyrgn/netcorewebapibestpractices/blob/main/NetCoreBestPractices/NetCoreBestPractices.API/Startup.cs"
    click Program "https://github.com/mtnyrgn/netcorewebapibestpractices/blob/main/NetCoreBestPractices/NetCoreBestPractices.API/Program.cs"
    click CategoryDTO "https://github.com/mtnyrgn/netcorewebapibestpractices/tree/main/NetCoreBestPractices/NetCoreBestPractices.API/DTO/Category"
    click ProductDTO "https://github.com/mtnyrgn/netcorewebapibestpractices/tree/main/NetCoreBestPractices/NetCoreBestPractices.API/DTO/Product"
    click PersonDTO "https://github.com/mtnyrgn/netcorewebapibestpractices/tree/main/NetCoreBestPractices/NetCoreBestPractices.API/DTO/Person"
    click ErrorDTO "https://github.com/mtnyrgn/netcorewebapibestpractices/blob/main/NetCoreBestPractices/NetCoreBestPractices.API/DTO/Error/ErrorDto.cs"
    click Logging "https://github.com/mtnyrgn/netcorewebapibestpractices/blob/main/NetCoreBestPractices/NetCoreBestPractices.Logging"
    click UnitOfWork "https://github.com/mtnyrgn/netcorewebapibestpractices/blob/main/NetCoreBestPractices/NetCoreBestPractices.Data/UnitOfWorks/UnitOfWork.cs"
    click SQLRepo "https://github.com/mtnyrgn/netcorewebapibestpractices/blob/main/NetCoreBestPractices/NetCoreBestPractices.Data/Repositories/Repository.cs"
    click MongoRepo "https://github.com/mtnyrgn/netcorewebapibestpractices/blob/main/NetCoreBestPractices/NetCoreBestPractices.Data/Repositories/MongoRepository.cs"
    click SQLServer "https://github.com/mtnyrgn/netcorewebapibestpractices/blob/main/NetCoreBestPractices.Core"
    click MongoDB "https://github.com/mtnyrgn/netcorewebapibestpractices/blob/main/NetCoreBestPractices.Core"
    click Domain "https://github.com/mtnyrgn/netcorewebapibestpractices/blob/main/NetCoreBestPractices/NetCoreBestPractices.Core/Entities/Category.cs"
    click Contracts "https://github.com/mtnyrgn/netcorewebapibestpractices/blob/main/NetCoreBestPractices/NetCoreBestPractices.Core/Repositories/IRepository.cs"
```
