docs: add layer readmes for architecture boundaries
This commit is contained in:
41
src/core/DigitalData.TaskFlow.Application/README.md
Normal file
41
src/core/DigitalData.TaskFlow.Application/README.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# DigitalData.TaskFlow.Application
|
||||
|
||||
Dieses Projekt enthaelt die Use-Case-Schicht der Anwendung.
|
||||
|
||||
## Zweck
|
||||
|
||||
Die Application-Schicht orchestriert fachliche Anwendungsfaelle. Sie nimmt Requests entgegen, validiert diese, ruft Domain-nahe Abstraktionen auf und liefert strukturierte Ergebnisse zurueck.
|
||||
|
||||
## Aktueller Inhalt
|
||||
|
||||
- `DependencyInjection.cs`
|
||||
- Registriert zentrale Application-Dienste:
|
||||
- MediatR
|
||||
- FluentValidation
|
||||
- AutoMapper
|
||||
- Bindet `MediatR`-Optionen inklusive Lizenzschluessel.
|
||||
- `Options/`
|
||||
- `MediatROptions`: Konfiguration fuer MediatR (z. B. `LuckyPennySoftLicenseKey`).
|
||||
|
||||
## Geplante Inhalte (naechste Phasen)
|
||||
|
||||
- `Features/`
|
||||
- Queries/Commands fuer Workflows, Closing und Documents.
|
||||
- `Validators/`
|
||||
- FluentValidation-Regeln pro Request.
|
||||
- `Common/Behaviors/`
|
||||
- Pipeline-Behavior (z. B. zentrale Request-Validierung).
|
||||
- `Common/Interfaces/`
|
||||
- Repository-Abstraktionen fuer Datenzugriff.
|
||||
- `Mappings/`
|
||||
- AutoMapper-Profile zwischen Infrastrukturmodellen und Domainmodellen.
|
||||
|
||||
## Architektur-Regeln
|
||||
|
||||
- Keine direkten SQL- oder EF-Core-Aufrufe.
|
||||
- Keine HTTP-spezifischen Controller-Abhaengigkeiten.
|
||||
- Kommunikation nach aussen nur ueber Interfaces.
|
||||
|
||||
## Rolle im Gesamtsystem
|
||||
|
||||
Diese Schicht ist der zentrale Ausfuehrungspunkt fuer Use-Cases und verbindet die API-Schicht mit Domain und Infrastructure, ohne Technologie-Details nach oben durchzureichen.
|
||||
33
src/core/DigitalData.TaskFlow.Domain/README.md
Normal file
33
src/core/DigitalData.TaskFlow.Domain/README.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# DigitalData.TaskFlow.Domain
|
||||
|
||||
Dieses Projekt bildet den fachlichen Kern von `DigitalData.TaskFlow`.
|
||||
|
||||
## Zweck
|
||||
|
||||
Die Domain-Schicht enthaelt ausschließlich fachliche Modelle und Begriffe. Hier wird beschrieben, **was** das System fachlich darstellt, nicht **wie** Daten gelesen/geschrieben werden.
|
||||
|
||||
## Aktueller Inhalt
|
||||
|
||||
- `Common/`
|
||||
- `ApiEnvelope<T>`: Standard-Response-Huelle mit `Meta` und `Data`.
|
||||
- `MetaEntry`: Einzelner Meta-Eintrag (`Code`, `Message`).
|
||||
- `Enums/`
|
||||
- `MetaCode`: Fachliche Status-Codes (z. B. `Ok`, `NoAccess`, `AlreadyClosed`).
|
||||
- `Workflows/`
|
||||
- Modelle fuer den Endpoint `GET /workflows/{wisagid}`.
|
||||
- Enthalten Quellblock-Struktur (`SourceBlock`, `FerdinandSourceBlock`, `ContractsSourceBlock`) und Untermodelle (`ProfileItem`, `WorkflowListingItem`, `ApprovalItem`, `DocumentReferenceItem`, `ClosingMethodItem`, `RejectionReasonItem`).
|
||||
- `Closing/`
|
||||
- Modelle fuer den Endpoint `POST /workflows/{wisagid}/{source}/{processid}/closing`.
|
||||
- `CloseWorkflowDecision` (Eingabe), `CloseWorkflowResult` (Ergebnis).
|
||||
- `Documents/`
|
||||
- `DocumentBinaryResult` fuer den Endpoint `GET /documents/{id}`.
|
||||
|
||||
## Architektur-Regeln
|
||||
|
||||
- Keine EF-Core-, HTTP-, SQL- oder Infrastruktur-Abhaengigkeiten.
|
||||
- Keine Controller- oder Middleware-Logik.
|
||||
- Modelle bleiben in PascalCase; technische DB-Namensabweichungen werden spaeter in Infrastructure gemappt.
|
||||
|
||||
## Warum diese Schicht wichtig ist
|
||||
|
||||
Die Domain stellt eine stabile, technologieunabhaengige Sprache bereit. Dadurch koennen API, Application und Infrastructure getrennt entwickelt werden, ohne den fachlichen Vertrag zu verlieren.
|
||||
Reference in New Issue
Block a user