TinyHelpers.AspNetCore 4.0.5

Tiny Helpers for ASP.NET Core

A collection of helper methods and classes for ASP.NET Core that I use every day. I have packed them in a single library to avoid code duplication.

[!IMPORTANT] Update from Version 3.x to 4.x Swashbuckle (Swagger) support has been moved out from TinyHelpers.AspNetCore. If you're using extension methods like AddAcceptLanguageHeader and AddDefaultResponse with AddSwaggerGen, now you need to install the TinyHelpers.AspNetCore.Swashbuckle package.

Installation

The library is available on NuGet. Just search for TinyHelpers.AspNetCore in the Package Manager GUI or run the following command in the .NET CLI:

dotnet add package TinyHelpers.AspNetCore

Usage

The library provides some useful extension methods for ASP.NET Core applications:

• AddDefaultProblemDetails: calls the default ProblemDetails extension method defining the CustomizeProblemDetails property to ensure that all the typical properties (Type, Title, Instance, TraceId) are correctly set.

• AddDefaultExceptionHandler: adds a default implementation for the IExceptionHandler interface that returns the following response on exceptions:

app.MapPost("/api/exception", () =>
{
    throw new Exception("This is an exception", innerException: new HttpRequestException("This is an inner exception"));
});

{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.6.1",
  "title": "System.Exception",
  "status": 500,
  "detail": "This is an exception",
  "instance": "/api/exception",
  "traceId": "00-1bffa22c7288e5784bf763d5fd05bc87-87da01a1b76d1692-00",
  "innerException": "System.Net.Http.HttpRequestException",
  "innerExceptionMessage": "This is an inner exception",
  "stackTrace": "..."
}

Note The StackTrace property is included in the response only if the application is running in the Development environment.

• AddRequestLocalization(cultures): an overload of the standard AddRequestLocalization extension method that just requires the list of supported cultures and automatically registers the corresponding RequestLocalizationOptions (Note: The first culture in the list is used as the default culture).

• ConfigureAndGet<TOptions>( ): it allows to register a configuration instance on type TOptions and returns the instance itself. It is useful when you need to configure the options and gets the reference to that instance in the same method, typically at application startup.

• AddAcceptLanguageHeader(): adds the Accept-Language header to OpenAPI definition:

builder.Services.AddOpenApi(options =>
{
    options.AddAcceptLanguageHeader();
});

Contribute

The project is constantly evolving. Contributions are welcome. Feel free to file issues and pull requests on the repo and we'll address them as we can.

Warning Remember to work on the develop branch, don't use the master branch directly. Create Pull Requests targeting develop.