AbsoluteAlgorithm.Api.Common 1.0.0-dev.12

AbsoluteAlgorithm.Api.Common

A comprehensive common library for building robust ASP.NET Core Web APIs, featuring database management, audit logging, rate limiting, and standard middleware pipelines.

Installation

Install the package via NuGet:

dotnet add package AbsoluteAlgorithm.Api.Common --prerelease

Usage Setup

Configure the application in Program.cs using ApplicationConfiguration to set up databases, rate limiting, and the absolute pipeline.

try
{
    ApplicationConfiguration appConfig = new ApplicationConfiguration
    {
        UseRelationalDatabase = true,
        DatabasePolicies = new List<DatabasePolicy>
        {
            new DatabasePolicy
            {
                DatabaseProvider = DatabaseProvider.MSSQL,
                ConnectionStringName = "MSSQLCS",
                InitializeDatabase = true,
                InitializeAuditTable = true,
                InitializationScript = msSqlScript,
                DatabaseName = "testdb",
                MaxPoolSize = 100,
                MinPoolSize = 10,
                CommandTimeoutSeconds = 30
            },
            new DatabasePolicy
            {
                DatabaseProvider = DatabaseProvider.PostgreSQL,
                ConnectionStringName = "POSTGRESCS",
                InitializeDatabase = true,
                InitializeAuditTable = true,
                InitializationScript = postgreSqlScript,
                DatabaseName = "test_db",
                MaxPoolSize = 100,
                MinPoolSize = 10,
                CommandTimeoutSeconds = 30
            }
        },
        UseRateLimit = true,
        RateLimitPolicies = new List<RateLimitPolicy>
        {
            new RateLimitPolicy
            {
                PolicyName = "rpol",
                Algorithm = RateLimitAlgorithm.FixedWindow,
                Scope = RateLimitScope.IpAddress,
                PermitLimit = 2,
                Window = TimeSpan.FromSeconds(2)
            }
        }
    };
    #endregion

    WebApplicationBuilder builder = WebApplication.CreateBuilder(args);
    builder.RegisterAbsoluteWebApplicationBuilder(appConfig);

    WebApplication app = builder.Build();

    app.UseAbsolutePipeline(appConfig);

    app.Run();
}
catch (Exception ex)
{
    var logger = LogManager.GetCurrentClassLogger();
    logger.Error(ex, "an error occured: {message}", ex.Message);
    throw;
}
finally
{
    LogManager.Shutdown();
}

Configuration Reference

ApplicationConfiguration

DatabasePolicy

RateLimitPolicy