Resulver.AspNetCore.FastEndpoints
2.0.0
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 Resulver.AspNetCore.FastEndpoints --version 2.0.0
NuGet\Install-Package Resulver.AspNetCore.FastEndpoints -Version 2.0.0
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="Resulver.AspNetCore.FastEndpoints" Version="2.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Resulver.AspNetCore.FastEndpoints --version 2.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Resulver.AspNetCore.FastEndpoints, 2.0.0"
#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 Resulver.AspNetCore.FastEndpoints as a Cake Addin #addin nuget:?package=Resulver.AspNetCore.FastEndpoints&version=2.0.0 // Install Resulver.AspNetCore.FastEndpoints as a Cake Tool #tool nuget:?package=Resulver.AspNetCore.FastEndpoints&version=2.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Table of content
Installation
dotnet add package Resulver.AspNetCore.FastEndpoints
Error Handling
1. First, add the following code to the Program.cs file:
builder.Services.AddResulver(Assembly.GetExecutingAssembly());
2. Create Error Profiles
In this example, we have created an error named ValidationError :
public class ValidationError(string title, string message) : ResultError(message, title: title);
Now, to manage responses related to this error, we will create a profile for it.
public class ValidationErrorProfile : ErrorProfile
{
public override void Configure()
{
AddError<ValidationError>().WithStatusCode(400);
}
}
Using in Endpoints
You can use the following methods to utilize IResultHandler in your Endpoints :
Method 1: Inheritance from the ResultBaseEndpoint class :
public class MyEndpoints : ResultBaseEndpoint<string,string>
{
public override void Configure()
{
Post("my-endpoint");
AllowAnonymous();
}
public override Task HandleAsync(string req, CancellationToken ct)
{
// logic
//
//
var result = new Result<string>("this is result message");
return SendFromResultAsync(result,200,ct);
}
}
Note: In all cases, if the Result contains an error, a response will be generated based on the error profile created for that error.
Method 2: Inject IErrorResponseGenerator in to your Endpoint:
public class MyEndpoints : Ep.Req<string>.Res<string>
{
public required IErrorResponseGenerator<FailureResponse> ErrorResponseGenerator { get; init; }
public override void Configure()
{
Post("my-endpoint");
AllowAnonymous();
}
public override Task HandleAsync(string req, CancellationToken ct)
{
// logic
//
//
var result = new Result<string>("this is result message");
if (result.IsFailure)
{
var failureResponse = ErrorResponseGenerator.MakeResponse(result.Errors[0]) ;
AddError(failureResponse);
return SendErrorsAsync(failureResponse.StatusCode,ct);
}
return SendOkAsync(result.Message,ct);
}
}
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net8.0 is compatible. 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.
-
net8.0
- FastEndpoints (>= 5.31.0)
- Microsoft.Extensions.DependencyInjection (>= 9.0.0)
- Resulver.AspNetCore.Core (>= 2.0.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.