DotNetBrightener.AspNet.Extensions.SelfDocumentedProblemResult.UI 2025.0.6-preview-333

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

UI for ASP.NET Core Problem Result Extension

© 2025 DotNet Brightener

NuGet Version

Introduction

This is an extensions for ASP.Net Core applications that use the ProblemResult package. This package provides a UI for viewing information about a specific error / exception that can be thrown by the application.

Check out the ProblemResult package for more details on how to implement self-documented error objects.

Installation

You can install the package from NuGet:


dotnet add package DotNetBrightener.AspNet.Extensions.SelfDocumentedProblemResult.UI

Enable UI for viewing errors information

1. Enable generate XML documentation file in your projects / solutions.

Add the following code to the section <PropertyGroup> in your your .csproj file:

<GenerateDocumentationFile>true</GenerateDocumentationFile>

If you have multiple projects in your solution, you'll need to add the above code to all of the projects. Another way is to add that to the Directory.Build.props file in the root of your solution.

2. Configure the ASP.Net project to use the UI package.

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


app.MapErrorDocsTrackerUI(options =>
{
    options.UiPath = "/errors-info-ui"; // this is where you can access the UI from your application
    options.ApplicationName = "Test Error"; // this is the name of your application
});

How this work?

When your application is configured to use UI package, the application will collect the error classes that are derived from IProblemResult. The error object when returned from the application, will now have type properties that leads to the information page of the error.

{
  "type": "https://localhost:7290/errors-info-ui#/WebAppCommonShared.Demo.Controllers.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": "/api/ExceptionTest/exception2/123",
  "data": {
    "userId": 123
  }
}

If developer / user opens the Url found in type property, they'll be able to see the information about the error. With the provided information, the developer can identify the issue and fix the issue easier. For the user, they can use this to seek support from developer.

Example

Given the error object defined as below:



/// <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);
    }
}

visiting the URL in type property will see an error page like following:

User Not Found Error

Description

The error represents the requested object of type User could not be found

Reason

The error is thrown because the requested resource of type User could not be found

Response HTTP Status Code

The request that encounters this error shall be responded with HTTP Status Code 404.

Additionally, refer to RFC 9110 Document Specification for Status Code 404.

Response Body

Below is the sample response body of the request that encounters this error. Depends on the error, there can be additional properties that help you identify the issue.

{
  "type": "https://localhost:7290/errors#WebAppCommonShared.Demo.Controllers.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": "{usually is URL of the request}"
}

The Description of the page is pulled from XML Document <summary> tag, and the Reason is pulled from <remarks> tag. The Response HTTP Status Code is the status code that the error object is associated with. The Response Body is the sample response body that the error object will be returned.

Product Compatible and additional computed target framework versions.
.NET 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.

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
2025.0.6-preview-369 13 8/27/2025
2025.0.6-preview-368 10 8/27/2025
2025.0.6-preview-334 123 8/18/2025
2025.0.6-preview-333 69 7/27/2025
2025.0.6-preview-332 441 7/24/2025
2025.0.6-preview-331 443 7/24/2025
2025.0.6-preview-328 439 7/24/2025
2025.0.6-preview-327 279 7/21/2025
2025.0.6-preview-326 277 7/21/2025
2025.0.6-preview-325 188 7/20/2025
2025.0.6-preview-324 185 7/20/2025
2025.0.6-preview-322 188 7/20/2025
2025.0.6-preview-321 188 7/19/2025
2025.0.6-preview-320 188 7/19/2025
2025.0.6-preview-319 118 7/17/2025
2025.0.6-preview-317 110 7/17/2025
2025.0.6-preview-316 113 7/17/2025
2025.0.6-preview-315 111 7/17/2025
2025.0.6-preview-314 110 7/17/2025
2025.0.6-preview-313 117 7/17/2025
2025.0.6-preview-312 117 7/16/2025
2025.0.5 141 7/10/2025
2025.0.5-preview-307 69 7/5/2025
2025.0.4 72 7/5/2025
2025.0.4-preview-305 81 7/4/2025
2025.0.4-preview-304 141 7/1/2025
2025.0.4-preview-299 118 5/31/2025
2025.0.4-preview-298 96 5/30/2025
2025.0.4-preview-296 135 5/30/2025
2025.0.4-preview-295 143 5/29/2025
2025.0.4-preview-293 147 5/26/2025
2025.0.4-preview-292 148 5/26/2025
2025.0.3 122 2/10/2025
2025.0.3-preview-288 108 2/10/2025
2025.0.2 123 1/21/2025
2025.0.2-preview-278 99 1/21/2025
2025.0.2-preview-277 119 12/16/2024
2025.0.1-rc-243301701 376 11/25/2024
2024.0.14.6 113 11/25/2024
2024.0.14.6-rc-243031001 177 10/29/2024
2024.0.14.6-rc-243030701 97 10/29/2024
2024.0.14.6-rc-242840501 101 10/10/2024
2024.0.14.6-rc-242820305 101 10/8/2024
2024.0.14.6-rc-242771401 201 10/3/2024
2024.0.14.6-rc-242770501 98 10/3/2024
2024.0.14.6-rc-242770201 116 10/3/2024
2024.0.14.6-rc-242761801 111 10/2/2024
2024.0.14.6-rc-242761601 115 10/2/2024
2024.0.14.6-rc-242761501 110 10/2/2024
2024.0.14.6-rc-242761401 110 10/2/2024
2024.0.14.6-rc-242760701 120 10/2/2024
2024.0.14.6-rc-242751002 105 10/1/2024
2024.0.14.6-rc-242750901 118 10/1/2024
2024.0.14.6-rc-242750502 109 10/1/2024
2024.0.14.6-rc-242750201 95 10/1/2024
2024.0.14.6-rc-242741501 93 9/30/2024
2024.0.14.6-rc-242730701 120 9/29/2024
2024.0.14.6-preview-2730501 85 9/29/2024
2024.0.14.6-preview-2701501 139 9/26/2024
2024.0.14.6-preview-2620901 152 9/18/2024
2024.0.14.6-preview-2570701 119 9/13/2024
2024.0.14.6-preview-2510703 161 9/7/2024
2024.0.14.6-preview-2480501 119 9/4/2024
2024.0.14.6-preview-2430401 146 8/30/2024
2024.0.14.6-preview-242730701 87 9/29/2024
2024.0.14.6-preview-2421703 103 8/29/2024
2024.0.14.6-preview-2421701 102 8/29/2024
2024.0.14.6-preview-2420901 101 8/29/2024
2024.0.14.6-preview-2390101 138 8/26/2024
2024.0.14.6-preview-2381603 141 8/25/2024
2024.0.14.6-preview-2341601 148 8/21/2024
2024.0.14.6-preview-2321602 126 8/20/2024
2024.0.14.6-preview-2190801 147 8/6/2024
2024.0.14.6-preview-2041501 112 7/22/2024
2024.0.14.6-preview-1920603 169 7/10/2024
2024.0.14.6-preview-1920301 115 7/10/2024
2024.0.14.6-preview-1911302 126 7/9/2024
2024.0.14.6-preview-1901001 130 7/8/2024
2024.0.14.6-preview-1900901 108 7/8/2024
2024.0.14.6-preview-1900801 116 7/8/2024
2024.0.14.6-preview-1860304 117 7/4/2024
2024.0.14.5 149 7/1/2024
2024.0.14.5-preview-1811601 117 6/29/2024
2024.0.14.5-preview-1810501 133 6/29/2024
2024.0.14.5-preview-180132 114 6/28/2024
2024.0.14.5-preview-180131 117 6/28/2024
2024.0.14.5-preview-180121 110 6/28/2024
2024.0.14.4 141 6/27/2024
2024.0.14.4-preview-8 114 6/27/2024
2024.0.14.4-preview-7 98 6/27/2024
2024.0.14.3 124 6/21/2024
2024.0.14.1 129 6/6/2024
2024.0.14.1-preview 93 6/6/2024
2024.0.14-preview-1 109 6/6/2024
2024.0.13.8-preview 109 6/6/2024
2024.0.13.2-preview-247 107 6/6/2024
2024.0.13.1-preview-0146 101 6/6/2024
2024.0.13-preview-1 113 6/6/2024
2024.0.12.15803-preview-03 109 6/6/2024
2024.0.12.15608 129 6/4/2024
2024.0.12.15515 175 6/3/2024
2024.0.12.15220 122 5/31/2024
2024.0.12.15220-alpha31-240... 99 5/31/2024
2024.0.12.14911 151 5/28/2024
2024.0.12.14910-alpha28-240... 101 5/28/2024
2024.0.12.14823 137 5/27/2024
2024.0.12.14522-alpha7-2405... 127 5/24/2024
2024.0.12.14514-alpha6-2405... 126 5/24/2024
2024.0.12.14511 146 5/24/2024
2024.0.12.14314 174 5/22/2024
2024.0.12.14114 159 5/20/2024
2024.0.12.12815 183 5/7/2024
2024.0.12.12814 149 5/7/2024
2024.0.12.12721 168 5/6/2024
2024.0.12.12702 154 5/5/2024
2024.0.12.12622 171 5/5/2024
2024.0.12.12514 147 5/4/2024
2024.0.12.12512 153 5/4/2024
2024.0.12.12510 154 5/4/2024
2024.0.12.12420 131 5/3/2024
2024.0.12.12319 111 5/2/2024
2024.0.12.12319-rc-2405021801 94 5/2/2024
2024.0.12.12318 97 5/2/2024
2024.0.12.12215 140 5/1/2024
2024.0.12.12011 136 4/29/2024
2024.0.12.11720 143 4/26/2024
2024.0.12.11719 133 4/26/2024
2024.0.12.11621 143 4/25/2024
2024.0.12.11523 134 4/24/2024
2024.0.12.11522 135 4/24/2024
2024.0.12.11417 155 4/23/2024
2024.0.12.11400 148 4/22/2024
2024.0.12.11316 153 4/22/2024
2024.0.11.10220 149 4/11/2024
2024.0.11.10120 130 4/10/2024
2024.0.11.10119 124 4/10/2024
2024.0.11.10115 130 4/10/2024
2024.0.11.9914 165 4/8/2024
2024.0.11.9901 126 4/7/2024
2024.0.11.9823 141 4/7/2024
2024.0.11.9401 140 4/2/2024
2024.0.11.9301 139 4/1/2024
2024.0.11.9206 141 3/31/2024
2024.0.11.9205 136 3/31/2024