SharpGrip FluentValidation AutoValidation is an extension of the FluentValidation library enabling automatic asynchronous validation in MVC controllers and minimal APIs (endpoints).
$ dotnet add package SharpGrip.FluentValidation.AutoValidation.Shared![FluentValidation.AutoValidation [Build]](https://github.com/SharpGrip/FluentValidation.AutoValidation/actions/workflows/Build.yaml/badge.svg){kind=icon}
SharpGrip FluentValidation AutoValidation is an extension of the FluentValidation (v10+) library enabling automatic asynchronous validation in MVC controllers and minimal APIs (endpoints). The library FluentValidation.AspNetCore is no longer being maintained and is unsupported. As a result, support for automatic validation provided by this library is no longer available. This library re-introduces this functionality for MVC controllers and introduces automatic validation for minimal APIs (endpoints). It enables developers to easily implement automatic validation in their projects.
Register your validators with the Microsoft DI service container, for instructions on setting that up please see https://docs.fluentvalidation.net/en/latest/di.html.
For MVC controllers reference NuGet package SharpGrip.FluentValidation.AutoValidation.Mvc (https://www.nuget.org/packages/SharpGrip.FluentValidation.AutoValidation.Mvc).
using SharpGrip.FluentValidation.AutoValidation.Mvc.Extensions;
builder.Services.AddFluentValidationAutoValidation();
For minimal APIs (endpoints) reference NuGet package SharpGrip.FluentValidation.AutoValidation.Endpoints (https://www.nuget.org/packages/SharpGrip.FluentValidation.AutoValidation.Endpoints).
Enabling minimal API (endpoint) automatic validation can be done on both route groups and routes.
using SharpGrip.FluentValidation.AutoValidation.Endpoints.Extensions;
builder.Services.AddFluentValidationAutoValidation();
var app = builder.Build();
var endpointGroup = app.MapGroup("/some-group").AddFluentValidationAutoValidation();
endpointGroup.MapPost("/", (SomeModel someModel) => $"Hello {someModel.Name}");
app.MapPost("/", (SomeOtherModel someOtherModel) => $"Hello again {someOtherModel.Name}").AddFluentValidationAutoValidation();
| Property | Default value | Description |
|---|---|---|
| DisableBuiltInModelValidation | false | Disables the built-in .NET model (data annotations) validation. |
| ValidationStrategy | ValidationStrategy.All | Configures the validation strategy. Validation strategy ValidationStrategy.All enables asynchronous automatic validation on all controllers inheriting from ControllerBase. Validation strategy ValidationStrategy.Annotations enables asynchronous automatic validation on controllers inheriting from ControllerBase decorated (class or method) with a [FluentValidationAutoValidationAttribute] attribute. |
| EnableBodyBindingSourceAutomaticValidation | true | Enables asynchronous automatic validation for parameters bound from BindingSource.Body binding sources (typically parameters decorated with the [FromBody] attribute). |
| EnableFormBindingSourceAutomaticValidation | false | Enables asynchronous automatic validation for parameters bound from BindingSource.Form binding sources (typically parameters decorated with the [FromForm] attribute). |
| EnableQueryBindingSourceAutomaticValidation | true | Enables asynchronous automatic validation for parameters bound from BindingSource.Query binding sources (typically parameters decorated with the [FromQuery] attribute). |
| EnablePathBindingSourceAutomaticValidation | false | Enables asynchronous automatic validation for parameters bound from BindingSource.Path binding sources (typically parameters decorated with the [FromRoute] attribute). |
| EnableCustomBindingSourceAutomaticValidation | false | Enables asynchronous automatic validation for parameters bound from BindingSource.Custom binding sources. |
using SharpGrip.FluentValidation.AutoValidation.Mvc.Extensions;
builder.Services.AddFluentValidationAutoValidation(configuration =>
{
// Disable the built-in .NET model (data annotations) validation.
configuration.DisableBuiltInModelValidation = true;
// Only validate controllers decorated with the `FluentValidationAutoValidation` attribute.
configuration.ValidationStrategy = ValidationStrategy.Annotation;
// Enable validation for parameters bound from `BindingSource.Body` binding sources.
configuration.EnableBodyBindingSourceAutomaticValidation = true;
// Enable validation for parameters bound from `BindingSource.Form` binding sources.
configuration.EnableFormBindingSourceAutomaticValidation = true;
// Enable validation for parameters bound from `BindingSource.Query` binding sources.
configuration.EnableQueryBindingSourceAutomaticValidation = true;
// Enable validation for parameters bound from `BindingSource.Path` binding sources.
configuration.EnablePathBindingSourceAutomaticValidation = true;
// Enable validation for parameters bound from 'BindingSource.Custom' binding sources.
configuration.EnableCustomBindingSourceAutomaticValidation = true;
// Replace the default result factory with a custom implementation.
configuration.OverrideDefaultResultFactoryWith<CustomResultFactory>();
});
public class CustomResultFactory : IFluentValidationAutoValidationResultFactory
{
public IActionResult CreateActionResult(ActionExecutingContext context, ValidationProblemDetails? validationProblemDetails)
{
return new BadRequestObjectResult(new {Title = "Validation errors", ValidationErrors = validationProblemDetails?.Errors});
}
}
using SharpGrip.FluentValidation.AutoValidation.Endpoints.Extensions;
builder.Services.AddFluentValidationAutoValidation(configuration =>
{
// Replace the default result factory with a custom implementation.
configuration.OverrideDefaultResultFactoryWith<CustomResultFactory>();
});
public class CustomResultFactory : IFluentValidationAutoValidationResultFactory
{
public IResult CreateResult(EndpointFilterInvocationContext context, ValidationResult validationResult)
{
var validationProblemErrors = validationResult.ToValidationProblemErrors();
return Results.ValidationProblem(validationProblemErrors, "Some details text.", "Some instance text.", (int) HttpStatusCode.BadRequest, "Some title.");
}
}