Cheat Sheet
Packages
dotnet add package Jeninnet.Validation --version 1.0.0-preview.2
dotnet add package Jeninnet.Validation.Analyzers --version 1.0.0-preview.2
dotnet add package Jeninnet.Validation.AspNetCore --version 1.0.0-preview.2
dotnet add package Jeninnet.Validation.MediatR --version 1.0.0-preview.2
dotnet add package Jeninnet.Validation.DataAnnotations --version 1.0.0-preview.2
dotnet add package Jeninnet.Validation.Blazor --version 1.0.0-preview.2
dotnet add package Jeninnet.Validation.JsonSchema --version 1.0.0-preview.2
dotnet add package Jeninnet.Validation.OpenApi --version 1.0.0-preview.2
dotnet add package Jeninnet.Validation.ClientRules --version 1.0.0-preview.2
dotnet add package Jeninnet.Validation.Localization --version 1.0.0-preview.2
dotnet add package Jeninnet.Validation.Assertions --version 1.0.0-preview.2
Validator skeleton
public sealed class CustomerValidator : Validator<Customer>
{
protected override void Configure(ValidatorRuleBuilder<Customer> builder)
{
builder.RuleFor(x => x.Name, nameof(Customer.Name))
.NotEmpty()
.Length(1, 100);
}
}
Run
var result = validator.Validate(model);
var asyncResult = await validator.ValidateAsync(model, cancellationToken);
validator.ValidateAndThrow(model);
Rules
| Need |
Rule |
| Required |
NotNull, NotEmpty |
| Range |
InclusiveBetween(min, max), ExclusiveBetween |
| Compare |
GreaterThan, LessThan, Equal, NotEqual |
| String length |
Length(min, max), ExactLength, MinimumLength, MaximumLength |
| Pattern |
Matches(pattern) |
| Formats |
EmailAddress, Phone, Url, IPAddress, CreditCard, Base64String |
| Collections |
Count, MinCount, MaxCount, ForEach, Where, WhereAsync |
| Dates |
Before, After |
| Custom |
Must, MustAsync, Custom, CustomAsync |
Options
.WithMessage("...") // fallback when no localization template exists
.WithCode("CODE")
.WithSeverity(ValidationErrorSeverity.Warning)
.WithName("ReportedName") // replaces ValidationError.MemberName
.WithState(new { source = "api" })
Rule sets
builder.RuleSet("Admin", admin =>
admin.RuleFor(x => x.InternalScore, nameof(Customer.InternalScore))
.InclusiveBetween(0, 100));
validator.Validate(model, ["Admin"]); // Admin only
validator.Validate(model, ["default", "Admin"]); // ungrouped + Admin
validator.Validate(model, ruleSets: null); // all rules
Cascade and fail-fast
.Cascade(CascadeMode.Stop)
ClassLevelCascadeMode = CascadeMode.Stop;
validator.Validate(model, new ValidationCallOptions { FailFast = true });
Conditions and dependents
.GreaterThan(0).When(x => x.Country == "US");
.GreaterThan(0).When(x => x.Country == "US", ApplyConditionTo.AllValidators);
.DependentRules(d => d.RuleFor(x => x.Rate, nameof(Order.Rate)).GreaterThan(0));
DI
services.AddScoped<IValidator<Customer>, CustomerValidator>(); // explicit, AOT-safe
// Reflection-based discovery; not AOT-safe:
services.AddGeneratedValidators(typeof(CustomerValidator).Assembly);
ASP.NET Core
services.AddValidationEndpoints();
app.MapPost("/users", handler).AddRequestValidation<CreateUser>();
services.AddMvcValidation();
services.AddValidationPipeline();
services.AddScoped<IValidator<CreateOrderCommand>, CreateOrderCommandValidator>();
DataAnnotations
[JeninnetValidatable(typeof(CreateOrderValidator))]
public sealed class CreateOrderRequest { /* ... */ }
Blazor
<JeninnetValidator TModel="Order" />
Schema / OpenAPI / client
ValidationSchemaWriter.WriteToString(descriptor);
services.AddSchemaConstraintsFromValidators(new OrderValidator());
ClientRulesWriter.WriteToString([validator]);
Testing
result.ShouldHaveValidationErrors()
.ForMember(nameof(Customer.Email))
.ContainsRule(ValidationMessageKeys.EMAIL);
Checks
dotnet build Jeninnet.Validation.slnx
dotnet test Jeninnet.Validation.slnx
dotnet format Jeninnet.Validation.slnx --verify-no-changes --severity info