MSCrud.Core 0.4.1

MSCrud

Generic CRUD stack for ASP.NET Core + EF Core. Register an entity once and get a full REST endpoint (GetAll, GetById, Create, Update, Delete, Search, Find) with pagination, validation, optional caching and audit support — no per-entity controller, service or repository code required.

Quickstart

builder.Services.AddControllers()
    .AddCrud(o => { o.CachingEnabled = true; o.RoutePrefix = "/api/v1"; })
    .AddCrudEntity<Example, ExampleDTO, ExampleAttributesDTO, int>(o => o.WithMapper<ExampleMapper>());

// MSCrud resolves a plain DbContext; forward it to your concrete context.
builder.Services.AddScoped<DbContext>(sp => sp.GetRequiredService<BaseProjectContext>());

This exposes Example at /api/v1/Example with the standard CRUD + Search/Find actions.

Requirements per entity

• The entity implements IEntityId<TKey> (and optionally IAuditableEntity for audit columns).
• An ICrudMapper<TEntity, TDto, TAttributesDto> implementation, registered via o.WithMapper<ExampleMapper>().
• A FluentValidation IValidator<TDto> with "Insert" and "Update" rule sets (used by the generic controller).
• Application-wide implementations of ILocalizationProvider and, when caching is enabled, ICacheProvider registered in DI. Your provider must resolve the response message keys the stack uses internally (e.g. "Entity created", "Entity not found", "Entity already exists", "Entity could not be saved") — see CHANGELOG.md for keys added by version.

Customization

AddCrudEntity accepts per-entity overrides:

.AddCrudEntity<Example, ExampleDTO, ExampleAttributesDTO, int>(o => o
    .WithMapper<ExampleMapper>()
    .WithRepository<ExampleRepository>()   // subclass CrudRepository to add Includes/ordering
    .WithService<ExampleService>()         // replace the default CrudService
    .DisableCaching()                      // or .EnableCaching() to override the global default
    .DisableSoftDeleteCascade())           // or .EnableSoftDeleteCascade() to override the global default

AddCrud options (CrudOptions): DefaultPageSize (10), MaxPageSize (100), MinSearchLength (3), CachingEnabled (true), RoutePrefix (/api/v1), ReadBackAfterWrite (true) — set it to false to skip the post-save re-read on Create/Update when the response only needs the tracked entity's scalar values (no eager-loaded navigations or database-computed columns) — and SoftDeleteCascade (true). See CHANGELOG.md for what's new in each release.

Soft-delete cascade

Deleting an auditable entity recursively soft-deletes its active FK children (e.g. deleting a User soft-deletes its UserGroup join rows; Group rows are untouched). Controlled globally by CrudOptions.SoftDeleteCascade (default true) and per entity via EnableSoftDeleteCascade()/DisableSoftDeleteCascade(). When resolved to disabled for an entity with active children, Delete fails with the "Entity has child dependencies" message (restrict). Non-auditable children are never touched (a remove would hard-delete them). Child discovery ignores HasQueryFilters (0.4.1): tenant/visibility filters cannot hide children from the restrict check or the cascade — only the walk's own !IsDeleted predicate excludes rows. See CHANGELOG.md 0.4.0 for the full contract.

Search and filtering

• Mark string properties with [Searchable] to include them in GET /Search?search= (SQL LIKE).

• Mark FK/value-type properties with [Filterable] for exact-match filtering through POST /Find (query-by-example).

• To filter one column by multiple values (SQL IN), add a companion collection property marked [FilterableIn(nameof(TargetProp))] to the entity and the DTO, and copy it in the mapper's ToEntity. On EF entities the property must also carry [NotMapped] (EF would otherwise map a bare List<int> as a primitive collection column):

  public class Order : IEntityId<int>
  {
      [Filterable]
      public int OrderStatusId { get; set; }
  
      [NotMapped]
      [FilterableIn(nameof(OrderStatusId))]
      public List<int>? OrderStatusIds { get; set; }
  }
  // POST /Order/Find  {"orderStatusIds":[1,2,3]}  →  WHERE OrderStatusId IN (1,2,3)
  

  A null or empty collection means "not filtering" (same query-by-example gate as scalar properties). When both the scalar and the collection are set, the conditions are AND-chained. Misconfigured attributes (missing target property, element-type mismatch, attribute on a non-collection property) throw InvalidOperationException on the first Find/count query.