MinApiLib.Validation
7.0.2
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package MinApiLib.Validation --version 7.0.2
NuGet\Install-Package MinApiLib.Validation -Version 7.0.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="MinApiLib.Validation" Version="7.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add MinApiLib.Validation --version 7.0.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: MinApiLib.Validation, 7.0.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install MinApiLib.Validation as a Cake Addin #addin nuget:?package=MinApiLib.Validation&version=7.0.2 // Install MinApiLib.Validation as a Cake Tool #tool nuget:?package=MinApiLib.Validation&version=7.0.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
MinApiLib.Validation
This package contains extensions to use data annotations in your endpoints. It uses the MiniValidation library.
Installation
You can install this package using the NuGet package manager:
Install-Package MinApiLib.Validation
Or using the .NET CLI:
dotnet add package MinApiLib.Validation
Usage
To use the validation, you can use the WithValidation
extension method:
global using MinApiLib.Validation;
Now configure the validation filter in your endpoint:
public record struct Request(
[FromBody] RequestBody Body
);
public class RequestBody
{
[Required, StringLength(150, MinimumLength = 3)]
public string Name { get; set; }
[Required]
public string City { get; set; }
[Required]
public string Country { get; set; }
}
public record CreateThing() : PostEndpoint<Request>("things")
{
protected override RouteHandlerBuilder Configure(RouteHandlerBuilder builder)
=> builder
.Produces<Response>(StatusCodes.Status201Created)
.WithName("CreateThings")
.WithTags("things")
.WithValidation(); // invokes .ProducesValidationError()
protected override async Task<IResult> OnHandleAsync(Request request, CancellationToken cancellationToken)
{
// async stuff
return Results.Created($"/things/{created.Id}", created);
}
}
It will validate the request body and return a 400 status code response if the validation fails:
$ curl -X POST -H "Content-Type: application/json" -d '{"name":"John Doe"}' "http://localhost:5000/things"
{"City":["The City field is required."],"Country":["The Country field is required."]}%
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net7.0
- MiniValidation (>= 0.7.4)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.