AspNet.ExceptionMiddleware
1.0.0
dotnet add package AspNet.ExceptionMiddleware --version 1.0.0
NuGet\Install-Package AspNet.ExceptionMiddleware -Version 1.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="AspNet.ExceptionMiddleware" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="AspNet.ExceptionMiddleware" Version="1.0.0" />
<PackageReference Include="AspNet.ExceptionMiddleware" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add AspNet.ExceptionMiddleware --version 1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: AspNet.ExceptionMiddleware, 1.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.
#:package AspNet.ExceptionMiddleware@1.0.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=AspNet.ExceptionMiddleware&version=1.0.0
#tool nuget:?package=AspNet.ExceptionMiddleware&version=1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
AspNetCore.ExceptionMiddleware
Provides a custom middleware that generates an RFC response when an exception occurs, allowing you to unify error handling and response style, which simplifies debugging on both the client and server sides.
Usage
Just use ExceptionMiddleware
as a custom middleware in the Program.cs
class:
using AspNetCore.ExceptionMiddleware; // specify the namespace
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddControllers();
var app = builder.Build();
app.MapControllers();
app.UseMiddleware<ExceptionMiddleware>(); // specify the exception handler
app.Run();
After that, you will receive a clean and understandable error response:
{
"Type": "https://tools.ietf.org/html/rfc7231#section-6.5.8", // official documentation on the error
"Title": "Conflict", // a short, human-readable default description of the problem for this HTTP status
"Status": 409, // HTTP status code
"Detail": "There was a conflict when executing the request.", // your own error description message
"Instance": "/test/conflict/false" // the endpoint where the exception occurred
}
Depending on the error that occurred, you can use several exceptions:
- BadRequestException
- ConflictException
- ForbiddenException
- NotFoundException
- UnauthorizedException
- InternalServerErrorException
Example:
if (value < 0)
throw new BadRequestException("Value can not be less than 0.");
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 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. net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net7.0
- Microsoft.AspNetCore.Http.Abstractions (>= 2.3.0)
-
net8.0
- Microsoft.AspNetCore.Http.Abstractions (>= 2.3.0)
-
net9.0
- Microsoft.AspNetCore.Http.Abstractions (>= 2.3.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last Updated |
---|---|---|
1.0.0 | 118 | 8/21/2025 |