How mtnyrgn/netcorewebapibestpractices works
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