DotNetBrightener.AspNet.Extensions.SelfDocumentedProblemResult 2024.0.13-preview-1

This is a prerelease version of DotNetBrightener.AspNet.Extensions.SelfDocumentedProblemResult.
There is a newer version of this package available.
See the version list below for details.
dotnet add package DotNetBrightener.AspNet.Extensions.SelfDocumentedProblemResult --version 2024.0.13-preview-1
                    
NuGet\Install-Package DotNetBrightener.AspNet.Extensions.SelfDocumentedProblemResult -Version 2024.0.13-preview-1
                    
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="DotNetBrightener.AspNet.Extensions.SelfDocumentedProblemResult" Version="2024.0.13-preview-1" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="DotNetBrightener.AspNet.Extensions.SelfDocumentedProblemResult" Version="2024.0.13-preview-1" />
                    
Directory.Packages.props
<PackageReference Include="DotNetBrightener.AspNet.Extensions.SelfDocumentedProblemResult" />
                    
Project file
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 DotNetBrightener.AspNet.Extensions.SelfDocumentedProblemResult --version 2024.0.13-preview-1
                    
#r "nuget: DotNetBrightener.AspNet.Extensions.SelfDocumentedProblemResult, 2024.0.13-preview-1"
                    
#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 DotNetBrightener.AspNet.Extensions.SelfDocumentedProblemResult@2024.0.13-preview-1
                    
#: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=DotNetBrightener.AspNet.Extensions.SelfDocumentedProblemResult&version=2024.0.13-preview-1&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=DotNetBrightener.AspNet.Extensions.SelfDocumentedProblemResult&version=2024.0.13-preview-1&prerelease
                    
Install as a Cake Tool

ASP.NET Core WebApp Self-Documented Problem Result Extension

© 2024 DotNet Brightener

NuGet Version

Introduction

Have you ever wanted to have a consistent way of returning errors from your ASP.NET Core Web application? This package provides an abstraction for responding errors from your application to the client, base on the RFC 9457 specification.

When the application encounter an error, it should return a ProblemDetails object that contains information about the error.

This package

  • Added a global exception handler to catch unhandled exceptions and return a ProblemDetails object. An ILogger is also added to log the exception automatically for the unhandled exceptions.

  • Provides a based IProblembResult interface and its extension methods ToProblemDetails() or ToProblemResult(), to create consistent error responses. The error response format is based on the RFC 9457 specification.

When your application needs to response the error, you can either throw an exception derived from BaseProblemDetailsError class or simply create a class that implements IProblemResult interface. The error object will be converted to ProblemDetails object and returned to the client. Check Usage section for more information.

Installation

You can install the package from NuGet:


dotnet add package DotNetBrightener.AspNet.Extensions.SelfDocumentedProblemResult

Usage

1. Enable the global exception handler

Add the following code to your Startup.cs (if you use Startup.cs) or Program.cs (by default) file:


// this can be omitted if your application already added IHttpContextAccessor
builder.Services.AddSingleton<IHttpContextAccessor, HttpContextAccessor>();

// The default way of handling unhandled exceptions
builder.Services.AddExceptionHandler<UnhandledExceptionResponseHandler>();

// Adds services required for creation of <see cref="ProblemDetails"/> for failed requests.
builder.Services.AddProblemDetails();


// Add the following to your Configure method, 
// or after 
// var app = builder.Build(); if you use Program.cs
app.UseExceptionHandler();

After the configuration above, if your application throws an exception, the response will be a ProblemDetails object.

2. Create a consistent error response

2.1. Using Exception approach

Traditionally we used to throw exceptions when there are errors. You can create an exception class that inherits BaseProblemDetailsError class. The <summary> and <remarks> XML comments will be used to generate the ProblemDetails object.


/// <summary>
///     The error represents the requested object of type `User` could not be found
/// </summary>
/// <remarks>
///     The error is thrown because the requested resource of type `User` could not be found
/// </remarks>
public class UserNotFoundException : BaseProblemDetailsError
{
    public UserNotFoundException()
        : base("User Not Found", HttpStatusCode.BadRequest)
    {
    }

    public UserNotFoundException(long userId)
        : this()
    {
        Data.Add("userId", userId);
    }
}

Somewhere in your application, where an error is expected, you can throw the exception as followed:

// UserService.cs

    public User GetUser(long userId)
    {
        var user = _userRepository.GetUser(userId);

        if (user == null)
        {
            throw new UserNotFoundException(userId);
        }

        return user;
    }

Without having to handle the exception, the error will be caught by the global exception handler and return a ProblemDetails object.

// UserController.cs

    [HttpGet("{userId}")]
    public IActionResult GetUserDetail(long userId)
    {
        var user = _userService.GetUser(userId);

        // Without handling the exception, the error will be caught by the global exception handler

        return Ok(user);
    }

2.2. Using ProblemResult approach

Create a class that inherits BaseProblemDetailsError. The <summary> and <remarks> XML comments will be used to generate the ProblemDetails object.


using AspNet.Extensions.SelfDocumentedProblemResult.ErrorResults;

/// <summary>
///     The error represents the requested object of type `User` could not be found
/// </summary>
/// <remarks>
///     The error is thrown because the requested resource of type `User` could not be found
/// </remarks>
public class UserNotFoundError : BaseProblemDetailsError
{
    public UserNotFoundError()
        : base(HttpStatusCode.NotFound)
    {

    }

    public UserNotFoundError(long userId)
        : this()
    {
        Data.Add("userId", userId);
    }
}

// UserService.cs

    public User GetUser(long userId)
    {
        var user = _userRepository.GetUser(userId);

        return user;
    }

Somewhere in your controller, where an error is expected, you can return the error like this:

// UserController.cs
    [HttpGet("{userId}")]
    public IActionResult GetUserDetail(long userId)
    {
        var user = _userService.GetUser(userId);
        if (user == null)
        {
            // Explicitly return the error
            var error = new UserNotFoundError(userId);

            return error.ToProblemResult();
        }

        // Omited for brevity
    }

In the above snippet, where the user is not found, a response of status code 404 will be returned with the following body:


{
   "type": "UserNotFoundError",
   "title": "User Not Found Error",
   "status": 404,
   "detail": "The error is thrown because the requested resource of type `User` could not be found",
   "instance": "/users/123",
   "data": {
       "userId": 123
   }
}

The XML comments for the class will be used to generate the detail information about the error. It can be useful if you use the UI package, as the error information can be obtain via the UI.

Product 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.  net9.0 was computed.  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.
  • net8.0

    • No dependencies.

NuGet packages (4)

Showing the top 4 NuGet packages that depend on DotNetBrightener.AspNet.Extensions.SelfDocumentedProblemResult:

Package Downloads
DotNetBrightener.WebApi.GenericCRUD

Package Description

DotNetBrightener.WebApp.CommonShared

Package Description

DotNetBrightener.LocaleManagement

Package Description

DotNetBrightener.AspNet.Extensions.SelfDocumentedProblemResult.UI

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
2025.0.6-preview-333 55 7/27/2025
2025.0.6-preview-332 435 7/24/2025
2025.0.6-preview-331 435 7/24/2025
2025.0.6-preview-328 434 7/24/2025
2025.0.6-preview-327 273 7/21/2025
2025.0.6-preview-326 270 7/21/2025
2025.0.6-preview-325 181 7/20/2025
2025.0.6-preview-324 177 7/20/2025
2025.0.6-preview-322 182 7/20/2025
2025.0.6-preview-321 185 7/19/2025
2025.0.6-preview-320 184 7/19/2025
2025.0.6-preview-319 107 7/17/2025
2025.0.6-preview-317 105 7/17/2025
2025.0.6-preview-316 107 7/17/2025
2025.0.6-preview-315 107 7/17/2025
2025.0.6-preview-314 107 7/17/2025
2025.0.6-preview-313 113 7/17/2025
2025.0.6-preview-312 135 7/16/2025
2025.0.5 151 7/10/2025
2025.0.5-preview-307 89 7/5/2025
2025.0.4 86 7/5/2025
2025.0.4-preview-305 108 7/4/2025
2025.0.4-preview-304 152 7/1/2025
2025.0.4-preview-299 120 5/31/2025
2025.0.4-preview-298 101 5/30/2025
2025.0.4-preview-296 133 5/30/2025
2025.0.4-preview-295 154 5/29/2025
2025.0.4-preview-293 159 5/26/2025
2025.0.4-preview-292 161 5/26/2025
2025.0.3 145 2/10/2025
2025.0.3-preview-288 130 2/10/2025
2025.0.2 135 1/21/2025
2025.0.2-preview-278 112 1/21/2025
2025.0.2-preview-277 137 12/16/2024
2025.0.1-rc-243301701 406 11/25/2024
2024.0.14.6 149 11/25/2024
2024.0.14.6-rc-243031001 213 10/29/2024
2024.0.14.6-rc-243030701 142 10/29/2024
2024.0.14.6-rc-242840501 131 10/10/2024
2024.0.14.6-rc-242820305 138 10/8/2024
2024.0.14.6-rc-242771401 269 10/3/2024
2024.0.14.6-rc-242770501 131 10/3/2024
2024.0.14.6-rc-242770201 136 10/3/2024
2024.0.14.6-rc-242761801 129 10/2/2024
2024.0.14.6-rc-242761601 151 10/2/2024
2024.0.14.6-rc-242761501 125 10/2/2024
2024.0.14.6-rc-242761401 140 10/2/2024
2024.0.14.6-rc-242760701 145 10/2/2024
2024.0.14.6-rc-242751002 130 10/1/2024
2024.0.14.6-rc-242750901 160 10/1/2024
2024.0.14.6-rc-242750502 127 10/1/2024
2024.0.14.6-rc-242750201 125 10/1/2024
2024.0.14.6-rc-242741501 130 9/30/2024
2024.0.14.6-rc-242730701 153 9/29/2024
2024.0.14.6-preview-2730501 122 9/29/2024
2024.0.14.6-preview-2701501 175 9/26/2024
2024.0.14.6-preview-2620901 191 9/18/2024
2024.0.14.6-preview-2570701 132 9/13/2024
2024.0.14.6-preview-2510703 204 9/7/2024
2024.0.14.6-preview-2480501 170 9/4/2024
2024.0.14.6-preview-2430401 180 8/30/2024
2024.0.14.6-preview-242730701 131 9/29/2024
2024.0.14.6-preview-2421703 142 8/29/2024
2024.0.14.6-preview-2421701 135 8/29/2024
2024.0.14.6-preview-2420901 134 8/29/2024
2024.0.14.6-preview-2390101 161 8/26/2024
2024.0.14.6-preview-2381603 160 8/25/2024
2024.0.14.6-preview-2341601 171 8/21/2024
2024.0.14.6-preview-2321602 155 8/20/2024
2024.0.14.6-preview-2190801 190 8/6/2024
2024.0.14.6-preview-2041501 127 7/22/2024
2024.0.14.6-preview-1920603 211 7/10/2024
2024.0.14.6-preview-1920301 139 7/10/2024
2024.0.14.6-preview-1911302 156 7/9/2024
2024.0.14.6-preview-1901001 149 7/8/2024
2024.0.14.6-preview-1900901 144 7/8/2024
2024.0.14.6-preview-1900801 142 7/8/2024
2024.0.14.6-preview-1860304 125 7/4/2024
2024.0.14.5 193 7/1/2024
2024.0.14.5-preview-1811601 140 6/29/2024
2024.0.14.5-preview-1810501 156 6/29/2024
2024.0.14.5-preview-180132 144 6/28/2024
2024.0.14.5-preview-180131 129 6/28/2024
2024.0.14.5-preview-180121 125 6/28/2024
2024.0.14.4 161 6/27/2024
2024.0.14.4-preview-8 115 6/27/2024
2024.0.14.4-preview-7 136 6/27/2024
2024.0.14.4-preview-6 112 6/27/2024
2024.0.14.3 151 6/21/2024
2024.0.14.1 152 6/6/2024
2024.0.14.1-preview 122 6/6/2024
2024.0.14-preview-1 132 6/6/2024
2024.0.13.8-preview 131 6/6/2024
2024.0.13.2-preview-247 107 6/6/2024
2024.0.13.1-preview-0146 121 6/6/2024
2024.0.13-preview-1 117 6/6/2024
2024.0.12.15803-preview-03 133 6/6/2024
2024.0.12.15608 157 6/4/2024
2024.0.12.15515 212 6/3/2024
2024.0.12.15220 138 5/31/2024
2024.0.12.15220-alpha31-240... 113 5/31/2024
2024.0.12.14911 185 5/28/2024
2024.0.12.14910-alpha28-240... 119 5/28/2024
2024.0.12.14823 156 5/27/2024
2024.0.12.14522-alpha7-2405... 129 5/24/2024
2024.0.12.14514-alpha6-2405... 135 5/24/2024
2024.0.12.14511 167 5/24/2024
2024.0.12.14314 204 5/22/2024
2024.0.12.14114 186 5/20/2024
2024.0.12.12815 194 5/7/2024
2024.0.12.12814 146 5/7/2024
2024.0.12.12721 175 5/6/2024
2024.0.12.12702 160 5/5/2024
2024.0.12.12622 183 5/5/2024
2024.0.12.12514 162 5/4/2024
2024.0.12.12512 187 5/4/2024
2024.0.12.12510 176 5/4/2024
2024.0.12.12420 138 5/3/2024
2024.0.12.12319 129 5/2/2024
2024.0.12.12319-rc-2405021801 108 5/2/2024
2024.0.12.12318 119 5/2/2024
2024.0.12.12215 158 5/1/2024
2024.0.12.12011 174 4/29/2024
2024.0.12.11720 171 4/26/2024
2024.0.12.11719 165 4/26/2024
2024.0.12.11621 179 4/25/2024
2024.0.12.11523 158 4/24/2024
2024.0.12.11522 173 4/24/2024
2024.0.12.11417 168 4/23/2024
2024.0.12.11400 171 4/22/2024
2024.0.12.11316 177 4/22/2024
2024.0.11.10220 167 4/11/2024
2024.0.11.10120 152 4/10/2024
2024.0.11.10119 130 4/10/2024
2024.0.11.10115 137 4/10/2024
2024.0.11.9914 187 4/8/2024
2024.0.11.9901 150 4/7/2024
2024.0.11.9823 168 4/7/2024
2024.0.11.9401 181 4/2/2024
2024.0.11.9301 154 4/1/2024
2024.0.11.9206 179 3/31/2024
2024.0.11.9205 172 3/31/2024