Skip to content

solution_overview.md

Latest commit

 

History

History
133 lines (96 loc) · 4.02 KB

solution_overview.md

File metadata and controls

133 lines (96 loc) · 4.02 KB

Solution Overview

Below is a diagram and several descriptions to help you understand the layout of the solution and why assemblies have certain dependencies and why other dependent relationships must not exist.

💠 Dependency Diagram

  • Green Presentation Layer - Depends only on Infrastructure
  • Orange Infrastructure Layer - Depends on Application and Persistence
  • Red Persistence Layer - Depends on Application
  • Blue Business Layer - Application must ONLY depend on Domain and Events. Common is the only exception for shareable code.
  • Yellow Common Layer - No direct dependencies

🧩 Assembly Responsibilities

  • API - Provides presentation-specific dependency registrations through StartupOrchestrator<TOrchestrator>.
  • Azure Function - Provides presentation-specific dependency registrations through StartupOrchestrator<TOrchestrator>.
  • Console - Provides presentation-specific dependency registrations through StartupOrchestrator<TOrchestrator>.
  • Infrastructure - Handles dependency registrations for the application and persistence as well as 3rd party integration implementations such as HTTP Clients.
  • Persistence - Provides implementation details for persistence related interfaces in the application.
  • Application - Provides the dependency-free core business logic.
  • Domain - Provides the domain entities, enumerations, exceptions, constants, etc.
  • Events - Provides event-specific models and produces a NuGet package that can be consumed by other services that want to subscribe to these events.
  • Common - Provides shared code such as string or system extensions. This assembly can be referenced by all other assemblies.

📁 Folder Layouts

Below are examples of how files are organized within the projects. You can come up with your own ways to organize it, but this is a good place to start.

Application

configuration
// Contains configuration IOptions classes specific to application

entity
// User
    |---Commands
    // CreateUserCommand.cs
    |---Handlers
    // CreateUserHandler.cs
    // GetUserHandler.cs
    |---Queries
    // GetUserQuery.cs
    |---Validators
    // CreateUserValidator.cs
    // GetUserValidator.cs

interfaces
// Contains interfaces that the application depends on

mapping
// Contains 'request <-> domain' AutoMapper profiles or mapping actions

Domain

entities
// Contains the domain entity models

constants
// Contains enumerations and constants

exceptions
// Contains custom exceptions

Events

entity
// User
    |---Models
    // Address.cs
// UserCreated.cs
// UserUpdated.cs
// UserDeleted.cs

Infrastructure

configuration
// Contains configuration IOptions classes specific to infrastructure

extensions
// Contains infrastructure-specific extensions classes

services
// Contains non-persistence implementations for application interfaces

startup
// Startup orchestrator classes

Persistence

configuration
// Contains configuration IOptions classes specific to persistence

entity
// User - data access implementations

mapping
// Contains 'persistence <-> domain' AutoMapper profiles and mapping actions

API

configuration
// Contains configuration IOptions classes specific to the presentation

controllers
// Contains API controllers

mapping
// Contains 'presentation <-> request' AutoMapper profiles and mapping actions

Console and Azure Function have similar folder layouts to API. However, Microsoft recommends that each function in the Function App exist in its own folder. See Azure Function Best Practices.