Erp.Shared.API 1.1.7

Erp.Shared.API

Shared API components and extensions for ERP microservices including service registration, middleware, API versioning, logging, and MassTransit integration.

Version

Current Version: 1.1.0

Features

Service Registration Extensions

• AddRedisServices(): Redis caching with connection multiplexer
• AddSerilogLogging(): File and console logging with Serilog
• AddKubernetesLogging(): Kubernetes-optimized logging for Loki/Promtail/Grafana
• AddApiVersioningServices(): URL-based API versioning
• AddVersionedSwaggerGen(): Swagger with versioning and JWT support
• AddVersionedApiServices(): Complete API versioning + Swagger setup
• AddUserContextServices(): JWT authentication and user context
• AddPostgresDbContext<TContext>(): PostgreSQL with Entity Framework Core
• AddIntegrationEventPublisher(): MassTransit event publisher registration (New in v1.1.0)

User Context

• IUserExtension: Access to current user claims (UserId, CompanyId, BranchId, Roles)
• JWT token validation and role-based authorization

Installation

dotnet add package Erp.Shared.API --version 1.1.0

Usage

Basic Setup in Program.cs

using Shared.API.Extensions;

var builder = WebApplication.CreateBuilder(args);

// Add logging
builder.Services.AddSerilogLogging(
    builder.Configuration,
    serviceName: "MyService",
    enableFileLogging: true,
    enableConsoleLogging: true);

// Add Redis caching
builder.Services.AddRedisServices(builder.Configuration);

// Add API versioning with Swagger
builder.Services.AddVersionedApiServices(
    title: "My API",
    description: "My microservice API",
    includeJwtSecurity: true);

// Add user context and JWT authentication
builder.Services.AddUserContextServices(builder.Configuration);

// Add PostgreSQL database
builder.Services.AddPostgresDbContext<MyDbContext>(
    builder.Configuration,
    connectionStringName: "DefaultConnection");

// Add integration event publisher (NEW in v1.1.0)
builder.Services.AddIntegrationEventPublisher();

var app = builder.Build();

// Apply migrations at startup
app.ApplyMigrations<MyDbContext>();

// Use versioned Swagger
app.UseVersionedSwagger();

app.Run();

Using Integration Event Publisher

using Shared.Contracts.Common;

public class CompanyService
{
    private readonly IIntegrationEventPublisher _eventPublisher;

    public CompanyService(IIntegrationEventPublisher eventPublisher)
    {
        _eventPublisher = eventPublisher;
    }

    public async Task CreateCompany(Company company)
    {
        // Save company to database...

        // Publish integration event
        await _eventPublisher.PublishAsync(
            entityType: "Company",
            operation: "Created",
            payload: new {
                CompanyId = company.Id,
                Name = company.Name
            },
            source: "CompanyService");
    }
}

Accessing User Context

using Shared.API.Extensions.Auth;

public class MyController : ControllerBase
{
    private readonly IUserExtension _userExtension;

    public MyController(IUserExtension userExtension)
    {
        _userExtension = userExtension;
    }

    public IActionResult Get()
    {
        var userId = _userExtension.UserId;
        var companyId = _userExtension.CompanyId;
        var branchId = _userExtension.BranchId;
        var roles = _userExtension.Roles;

        // Use user context...
    }
}

Redis Caching

using Shared.Infrastructure.Redis.Services;

public class MyService
{
    private readonly IRedisService _redis;

    public MyService(IRedisService redis)
    {
        _redis = redis;
    }

    public async Task<MyData> GetData(string key)
    {
        return await _redis.GetAsync<MyData>(key);
    }

    public async Task SetData(string key, MyData data)
    {
        await _redis.SetAsync(key, data, TimeSpan.FromHours(1));
    }
}

PostgreSQL DbContext Registration

builder.Services.AddPostgresDbContext<ApplicationDbContext>(
    builder.Configuration,
    connectionStringName: "DefaultConnection",
    enableSensitiveDataLogging: false,
    enableDetailedErrors: false);

Your appsettings.json should include:

{
  "ConnectionStrings": {
    "DefaultConnection": "Host=localhost;Port=5432;Database=your_db;Username=your_user;Password=your_password"
  }
}

Automatic Database Migration at Startup

Apply pending migrations automatically at startup:

app.ApplyMigrations<ApplicationDbContext>();

Or with retry logic:

app.ApplyMigrationsWithRetry<ApplicationDbContext>(maxRetries: 5, retryDelaySeconds: 10);

Kubernetes Logging

For Kubernetes deployments with Loki/Promtail/Grafana:

builder.Services.AddKubernetesLogging(
    builder.Configuration,
    serviceName: "MyService",
    enableConsoleLogging: true,
    enableFileLogging: false); // Promtail reads from stdout

What's New in v1.1.0

• AddIntegrationEventPublisher(): New extension method to register MassTransit integration event publisher
• Enhanced ServiceCollectionExtensions with support for cross-service event-driven architecture
• Integration with Erp.Shared.Contracts v1.1.0 for event publishing

Configuration

appsettings.json Example

{
  "ConnectionStrings": {
    "DefaultConnection": "Host=localhost;Database=mydb;Username=user;Password=pass",
    "Redis": "localhost:6379"
  },
  "JwtSettings": {
    "Secret": "your-secret-key-here",
    "Issuer": "YourIssuer",
    "Audience": "YourAudience",
    "ExpirationInMinutes": 60
  }
}

Dependencies

• .NET 9.0
• Microsoft.AspNetCore.App
• Entity Framework Core 9.0
• Npgsql.EntityFrameworkCore.PostgreSQL 9.0
• Serilog 3.1.1
• StackExchange.Redis 2.7.17
• Swashbuckle.AspNetCore 6.5.0
• Erp.Shared.Infrastructure (project reference)
• Erp.Shared.Contracts (transitive dependency)

Related Packages

• Erp.Shared.Contracts: Shared DTOs and interfaces
• Erp.Shared.Infrastructure: Shared infrastructure components

License

MIT

Support

For issues and feature requests, please visit the GitHub repository.