Swan ASP.NET Core 3: Stuff We All Need

⭐ Please star this project if you find it useful!

A set of libraries to use with ASP.NET Core 3.0 applications. Also, includes a configure middleware and extension to setup your project. ASP.NET Core 3.0 came with a lot of changes, including authentication and authorization, here with Swan ASP.NET Core 3.0 is easy to configure and start working on your project.

NuGet Installation:

PM> Install-Package Unosquare.Swan.AspNetCore

Use Cases

Here we can find a very useful code to use in our project configuration. All of this you can use it in your Startup.cs file, see our Sample Project for more reference.

Using Bearer Token Authentication

The extension method AddBearerTokenAuthentication adds the services that are going to be used in your application. This method uses the Jwt schemes and adds a JwtBearer with the Token Validation Parameters that you configure. Jwt stands for JSON Web Tokens

The extension method UseBearerTokenAuthentication is important because it gives the application the requirements to use authentication and authorization with JWT.

With this configuration, you just need to add the data annotation [Authorize] to your API to say that the user needs to be authorized to access that part of your project.

This two are used together because you need to add the bearer token authentication to the services to use the bearer token authentication in your application. You just need to add in your ConfigureServices and your Configure.

// This method gets called by the runtime. Use this method to add services to the container
public void ConfigureServices(IServiceCollection services)
{
    // Extension method to add Bearer authentication
    services.AddBearerTokenAuthentication(ValidationParameters);
}

// This method gets called by the runtime. Use this method to configure the HTTP request pipeline
public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
{
    // Use the bearer token provider and check Admin and Pass.word as valid credentials
    app.UseBearerTokenAuthentication(
        ValidationParameters,
        (services, username, password, grantType, clientId) =>
        {
            if (username != "Admin" || password != "Pass.word")
                return Task.FromResult<ClaimsIdentity>(null);

            var claim = new ClaimsIdentity("Bearer");
            claim.AddClaim(new Claim(ClaimTypes.Name, username));

            return Task.FromResult(claim);
        }, (identity, obj) =>
        {
            // This action is optional
            obj["test"] = "OK";
            return Task.FromResult(obj);
        });
}

Using EntityFrameworkLogger

The EntityFrameworkLogger represents a Logger based on Entity Framework and adds a Logging subsystem. It will help you log into your Database everything necessary to know what’s going on in your application. This logger is used in the ConfigureServices method of your Startup.cs file.

With this you just add your configuration section and then add in the entity framework, your database context and the models that you use for log entries into your database, then you just pass the application services.

public void ConfigureServices(IServiceCollection services)
{
    // Inject your DbContext first.

        //  Add Entity Framework Logging Provider
    services.AddLoggingEntityFramework<SampleDbContext, Models.LogEntry>();
}

Using BusinessDbContext

The BusinessDbContext run business rules when you save changes to the database. It's helpful because if you want to modify an entity every time you save changes to the database, you can create a controller to do that. Your Db Context must inheritance from the BusinessDbContext in order to have this functionality and then you can add, remove and check for controllers using your context.

 public class SampleDbContext : BusinessDbContext
    {
        public SampleDbContext(DbContextOptions<SampleDbContext> options)
            : base(options)
        {
        }
    }

AuditTrail

Audit Trails is a business rule to save the changes to any operation performed in a record. In other words, capture what change between any data saving. This operation is important in many systems and you can accomplish with these extensions easily. The AuditTrailController can be attached to your BusinessDbContext and setup which Entities will be recorded in the three CRUD actions supported, create, update and delete.

public class SampleDbContext : BusinessDbContext
    {
         public SampleDbContext(DbContextOptions<SampleDbContext> options, IHttpContextAccessor httpContextAccessor)
            : base(options)
        {
            var auditController = new AuditTrailController<SampleDbContext, AuditTrailEntry>(this,
                httpContextAccessor?.HttpContext?.User?.Identity?.Name);
            auditController.AddTypes(ActionFlags.Create, new[] {typeof(Product)});

            AddController(auditController);
        }

        public DbSet<AuditTrailEntry> AuditTrailEntries { get; set; }
    }

Additional Extension Methods

Use the following extension methods to extend the ApplicationBuilder with helpful handlers.

The JsonExceptionHandler

Adding this extension is a very good way to debug your application. When an error occurs, the exception handles the error and send a 500 Internal Server Error HTTP Response with a JSON object containing useful information as stacktrace and inner exceptions.

// Response an exception as JSON at error
app.UseJsonExceptionHandler();

The Fallback

Redirect any 404 request without extension to specific URL like your index.html page. This is helpful when you are using client-side routing (like Angular) and redirect any unknown URL to the javascript application.

// Redirect anything without extension to index.html
app.UseFallback();