AstreCode.Backend.Shared.API 10.0.1.4

AstreCode.Backend.Shared.API

Shared backend components for AstreCode microservices.

Description

The AstreCode.Backend.Shared.API package provides essential shared components for building robust and scalable .NET 8.0 backend services. This package includes common middleware, configuration extensions, and utilities that streamline the development of microservices and API applications.

Installation

To install this package, use the .NET CLI:

dotnet add package AstreCode.Backend.Shared.API

Or via Package Manager Console:

Install-Package AstreCode.Backend.Shared.API

Features

🔧 Shared DTOs

• Standardized response models and data transfer objects
• Consistent API response formatting across all services
• Generic response wrapper for uniform API responses

🛡️ Common Middleware

• Global Exception Handler: Centralized error handling and logging
• Application Middleware: Request/response processing and correlation tracking
• Tenant Middleware: Multi-tenant support for SaaS applications
• Token Expiration Check: Automatic JWT token validation and refresh
• API Response Format Filter: Standardized response formatting
• Permission Authorization: Role and permission-based access control
• Group Authorization: Group-based access control

⚙️ Configuration Extensions

• API Configuration: Centralized API settings and versioning
• Serilog Configuration: Structured logging setup and configuration
• SSL/TLS Options: Secure communication configuration
• Security Extensions: Authentication and authorization setup

🔐 Security Features

• JWT Bearer token authentication
• Permission-based authorization attributes
• Group-based authorization
• SSL/TLS configuration options
• Secure token validation and expiration handling

📊 Monitoring & Logging

• Serilog integration for structured logging
• Prometheus metrics support
• Health check endpoints
• Request/response correlation tracking

Example Usage

Basic Setup

using Shared.API;

var builder = WebApplication.CreateBuilder(args);

// Add API services
builder.Services.AddApiServices(builder.Configuration);

// Add security
builder.Services.AddSecurity(builder.Configuration);

var app = builder.Build();

// Configure API pipeline
app.UseApiPipeline();

app.Run();

Global Exception Handling

// The global exception handler is automatically configured
// when you use the API pipeline setup
app.UseApiPipeline();

Permission-Based Authorization

[ApiController]
[Route("api/[controller]")]
public class ExampleController : ControllerBase
{
 [HttpGet]
 [PermissionAuthorize("Read:Example")]
 public async Task<IActionResult> GetExample()
 {
 // Your implementation here
 return Ok();
 }
}

Group-Based Authorization

[ApiController]
[Route("api/[controller]")]
public class AdminController : ControllerBase
{
 [HttpGet]
 [GroupAuthorize("Administrators")]
 public async Task<IActionResult> GetAdminData()
 {
 // Your implementation here
 return Ok();
 }
}

SSL/TLS Configuration

// In appsettings.json
{
 "SSLOptions": {
 "IsEnabled": true,
 "CertificatePath": "path/to/certificate.pfx",
 "CertificatePassword": "your-password",
 "Port": 443
 }
}

Configuration

API Configuration

// In appsettings.json
{
 "ApiConfiguration": {
 "CorsOrigin": "https://yourdomain.com",
 "CorsHeaders": "*",
 "CorsMethods": "*",
 "MajorVersion": 1,
 "MinorVersion": 0
 }
}

Serilog Configuration

// In appsettings.json
{
 "Serilog": {
 "SeqUrl": "http://localhost:5341",
 "LogPath": "logs/app.log"
 }
}

Dependencies

This package depends on the following NuGet packages:

• Microsoft.AspNetCore.Authentication.JwtBearer (8.0.7)
• Microsoft.EntityFrameworkCore.Design (8.0.7)
• Serilog.AspNetCore (8.0.2)
• Swashbuckle.AspNetCore (6.7.0)
• prometheus-net.AspNetCore (8.2.1)

Requirements

• .NET 8.0 or later
• ASP.NET Core 8.0 or later

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the file for details.

Support

For support and questions, please contact the AstreCode development team.

Changelog

See for version history and changes.

AstreCode.Backend.Shared.API - Version 8.0.0