Eliassen.AspNetCore.JwtAuthentication 0.1.81-dev-gh-pipline.3

Eliassen.AspNetCore.JwtAuthentication

Summary

This assembly contains methods for configuring JWT Bearer authentication for ASP.Net Core and SwaggerGen (OpenAPI3)

Getting started

To use these extensions, first add a reference to the Eliassen.AspNetCore.JwtAuthentication package in your project. Then, add the following namespaces to your IOC registation code:

using Eliassen.AspNetCore.JwtAuthentication;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;

Next, configure your JWT Bearer authentication and SwaggerGen services in your IServiceCollection using the extension methods:

public void ConfigureServices(IServiceCollection services)
{
    services.TryAddJwtBearerServices(configuration);
}

where configuration is your IConfiguration instance.

These extensions will configure JWT Bearer authentication and add SwaggerGen services for OAuth2 using the configuration sections specified in the JwtBearerOptions and OAuth2SwaggerOptions classes.

Configuration

The JWT Bearer authentication configuration is specified in the JwtBearerOptions class. The OAuth2SwaggerOptions class specifies the configuration for SwaggerGen services for OAuth2.

The configuration for JWT Bearer authentication is specified in the jwtBearerConfigurationSection parameter of the TryAddJwtBearerAuthentication method. The configuration for SwaggerGen services for OAuth2 is specified in the oAuth2SwaggerConfigurationSection parameter of the TryAddJwtBearerSwaggerGen method.

By default, the JwtBearerDefaults.AuthenticationScheme and OAuth2SwaggerOptions.DefaultScheme values are used for the default authentication scheme and the default scheme for SwaggerGen services, respectively.

Example

Here is an example of how to use the extension methods to configure JWT Bearer authentication and SwaggerGen services in an ASP.NET 8.0 project:

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers();

    services.TryAddJwtBearerServices(configuration);

    services.AddSwaggerGen(c =>
    {
        c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
    });
}

This code adds the JwtBearerAuthentication and SwaggerGen services to the IServiceCollection using the TryAddJwtBearerServices method. It also adds a Swagger documentation for an API with a version 1.