ilandev.AspNetCore.ExceptionHandler
0.1.2
dotnet add package ilandev.AspNetCore.ExceptionHandler --version 0.1.2
NuGet\Install-Package ilandev.AspNetCore.ExceptionHandler -Version 0.1.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="ilandev.AspNetCore.ExceptionHandler" Version="0.1.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ilandev.AspNetCore.ExceptionHandler --version 0.1.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: ilandev.AspNetCore.ExceptionHandler, 0.1.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 ilandev.AspNetCore.ExceptionHandler as a Cake Addin
#addin nuget:?package=ilandev.AspNetCore.ExceptionHandler&version=0.1.2
// Install ilandev.AspNetCore.ExceptionHandler as a Cake Tool
#tool nuget:?package=ilandev.AspNetCore.ExceptionHandler&version=0.1.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
ilandev.AspNetCore.ExceptionHandler
Customizable exception mapping middleware for ASP.NET Core. Allows you to specify custom response lambdas for specific exception types.
Usage
- Call
builder.Services.AddExceptionHandlingMiddleware()
and pass in a configuration action to configure the middleware. - Call
app.UseExceptionHandlingMiddleware()
after the call toapp.UseRouting()
.
Examples
builder.Services.AddExceptionHandlingMiddleware(c => c
.AddHandler<UserNotFoundException>(e => new ExceptionMapping
{
StatusCode = HttpStatusCode.BadRequest,
Response = new
{
ErrorCode = "user_not_found"
}
})
);
// ...
app.UseExceptionHandlingMiddleware();
Any exceptions thrown of type UserNotFoundException
(or any exceptions inheriting from this type) will cause the above-mentioned response to be written.
Middleware Configuration
Configuration | Default Value | Details |
---|---|---|
IgnoreTaskCancellation | true | Exceptions of type TaskCanceledException will be ignored, and a default response will be written instead. |
AllowExceptionInheritance | true | Whether to look for exception base classes when matching a handler. |
JsonSerializerOptions | null | Custom JsonSerializerOptions to use when writing the response. |
WriteExceptionDetails | false | Whether to print the exception message & stack trace when writing the default response. |
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
- No dependencies.
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.