Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/carl-hugo/fluentvalidation.aspnetcore.http
A simple ASP.NET Core 7+ Minimal API integration for FluentValidation 10+.
https://github.com/carl-hugo/fluentvalidation.aspnetcore.http
asp-net-core aspnet-core aspnetcore autovalidation endpoint fluent-validation fluentvalidation minimal-api minimalapi
Last synced: 11 days ago
JSON representation
A simple ASP.NET Core 7+ Minimal API integration for FluentValidation 10+.
- Host: GitHub
- URL: https://github.com/carl-hugo/fluentvalidation.aspnetcore.http
- Owner: Carl-Hugo
- License: mit
- Created: 2023-01-11T17:25:41.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-14T15:02:48.000Z (about 1 year ago)
- Last Synced: 2024-10-11T06:51:39.076Z (28 days ago)
- Topics: asp-net-core, aspnet-core, aspnetcore, autovalidation, endpoint, fluent-validation, fluentvalidation, minimal-api, minimalapi
- Language: C#
- Homepage:
- Size: 42 KB
- Stars: 32
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FluentValidation.AspNetCore.Http
[](https://github.com/Carl-Hugo/FluentValidation.AspNetCore.Http/actions/workflows/main.yml)
[](https://www.nuget.org/packages/ForEvolve.FluentValidation.AspNetCore.Http/)
[](https://f.feedz.io/forevolve/fluentvalidation/packages/ForEvolve.FluentValidation.AspNetCore.Http/latest/download)
A simple ASP.NET Core 7+ Minimal API integration for [FluentValidation](https://github.com/FluentValidation/FluentValidation) 10+.
The package leverages endpoint filters to trigger FluentValidation `IValidator`. In case of a validation error, the filter returns a `TypedResults.ValidationProblem(errors);`, where the `errors` argument represents the collection of failures. You can customize this behavior by implementing the `IFluentValidationEndpointFilterResultsFactory` interface.
## How to install
```
dotnet add package ForEvolve.FluentValidation.AspNetCore.Http
```
> Pre-release feedz.io URL:
>
> https://f.feedz.io/forevolve/fluentvalidation/nuget/index.json
## How to use
In your `Program.cs` file, you must register the library:
```csharp
builder.AddFluentValidationEndpointFilter();
```
You can then add the validation filter to an endpoint:
```csharp
using FluentValidation.AspNetCore.Http;
//...
app.MapGet("/some-path", (SomeParamToValidate model) => {
// ...
}).AddFluentValidationFilter();
```
You can also add the validation filter to a group instead, which applies the filter to all of the group's endpoints:
```csharp
using FluentValidation.AspNetCore.Http;
//...
var root = app
.MapGroup("/")
.AddFluentValidationFilter()
;
// Then you can register endpoints that will get validated, like:
root.MapGet("/some-path", (SomeParamToValidate model) => {
//...
});
```
You must register your validators normally. Here is an example that has nothing to do with this library and only uses FluentValidation:
```csharp
// Using the assembly scanning feature
builder.Services.AddValidatorsFromAssemblyContaining();
// Manually registering a validator
builder.Services.AddScoped, MyEntityValidator>();
```
## Settings
You can configure the `FluentValidationEndpointFilterSettings` class during the registration as follow:
```csharp
builder.AddFluentValidationEndpointFilter(settings => {
settings.ScanningStrategy = ScanningStrategy.ScanUntilNoValidatorFound;
});
```
You can also leverage ASP.NET Core `Configure` and `PostConfigure` methods as usual, like this:
```csharp
builder.Services.Configure(options =>
{
options.ScanningStrategy = ScanningStrategy.ScanUntilNoValidatorFound;
});
```
Finally, you can configure the filter in the `appsettings.json` file under the `FluentValidationEndpointFilter` key, like this:
```json
{
"FluentValidationEndpointFilter": {
"ScanningStrategy": "ScanUntilNoValidatorFound"
}
}
```
### ScanningStrategy
The only configuration at this time is the scanning strategy that contains the following options:
1. `ScanAllParams` (**default behavior**): The filter scans all parameters. For each parameter, it tries to get an `IValidator` instance from the ASP.NET Core container. When it finds one, the filter validates the parameter.
1. `ScanUntilNoValidatorFound`: The filter scans parameters until it does not find a validator for a parameter. When that happens, the validation stops.
> When using this strategy, you must first add the objects to validate, then add the services or other injected types.
## Examples
You can browse the `examples` directory for usage examples.
## Versioning
The package follows _semantic versioning_ and uses [Nerdbank.GitVersioning](https://github.com/dotnet/Nerdbank.GitVersioning) under the hood to automate versioning based on Git commits.