Home

Facet Documentation Index

Welcome to the Facet documentation! This index will help you navigate all available guides and references for using Facet and its extensions.

Table of Contents

• Facetting: Introduction to Facetting
• Quick Start: Quick Start Guide
• Attribute Reference: Facet Attribute Reference
• Custom Mapping: Custom Mapping with IFacetMapConfiguration & Async Support
• Property Mapping: Declarative property renaming with MapFrom attribute
• MapWhen Conditional Mapping: Conditionally map properties based on source values
• Inheritance Mapping: Working with inheritance hierarchies in source types and facet base classes
• Mapping Hooks: Before/After mapping hooks for validation, defaults, and computed values
• Extension Methods: Extension Methods (LINQ, EF Core, etc.)
• Advanced Scenarios: Advanced Usage Scenarios
  • Multiple facets from one source
  • Include/Exclude patterns
  • Nested Facets (single objects & collections)
  • Collection support (List, Array, ICollection, IEnumerable)
  • Inheritance and base classes
• Generated Files Output Configuration: Configure where generated files are written and make them visible in Solution Explorer
• What is Being Generated?: Before/After Examples
• Async Mapping Guide: Asynchronous Mapping with Facet.Mapping
• GenerateDtos Attribute: Auto-generate CRUD DTOs with GenerateDtos & GenerateAuditableDtos
• Expression Mapping: Transform business logic expressions between entities and DTOs with Facet.Mapping.Expressions
• Flatten Attribute: Automatically flatten nested objects into top-level properties for API responses and reports
• Wrapper Attribute: Generate reference-based wrappers for facade and decorator patterns with property delegation
• Analyzer Rules: Complete guide to Facet's Roslyn analyzers and diagnostic rules
• Source Signature Change Tracking: Track source entity changes with compile-time signature verification

Ecosystem packages

• Facet.Extensions.EFCore: EF Core Async Extension Methods
• Facet.Mapping Reference: Complete Facet.Mapping Documentation
• Facet.Mapping.Expressions Reference: Complete Expression Mapping Documentation