FG.MiddlewareCollection 1.0.0

FG.MiddlewareCollection

Overview

FG.MiddlewareCollection is a .NET library providing a robust collection of middleware for enhancing your ASP.NET Core application's request pipeline. It simplifies the integration of common functionalities like logging, error handling, rate limiting, and more.

Features

• Advanced request and error logging
• Configurable CORS and rate limiting
• Circuit breaker for fault tolerance
• IP whitelisting and blacklisting
• Middleware for response compression, XSS protection, and health checks

Installation

Install the package via NuGet:

Install-Package FG.MiddlewareCollection

Usage

Here are some examples demonstrating how to use the middleware in your ASP.NET Core application:

Advanced Logging Middleware

app.UseAdvancedLogging();

Error Logging Middleware

app.UseErrorLogging();

Health Check Middleware

app.UseHealthCheck();

Response Compression Middleware

app.UseResponseCompression();

IP Blacklisting Middleware

var blacklistedIPs = new[] { "192.168.1.1", "10.0.0.1" };
app.UseIPBlacklisting(services, blacklistedIPs);

IP Whitelisting Middleware

var whitelistedIPs = new[] { "192.168.1.2", "10.0.0.2" };
app.UseIPWhitelisting(services, whitelistedIPs);

Circuit Breaker Middleware

Using Options

var circuitBreakerOptions = new CircuitBreakerMiddlewareOptions
{
    Threshold = 5,
    OpenTime = TimeSpan.FromSeconds(30)
};
app.UseCircuitBreaker(services, circuitBreakerOptions);

Using Configuration

app.UseCircuitBreaker(services, configuration);

Rate Limiting Middleware

Simple Configuration

app.UseRateLimiting(services, rateLimitPerMinute: 100, limitExceedErrorMessage: "Too many requests. Try again later.");

Using Configuration

app.UseRateLimiting(services, configuration);

Using Options

var rateLimitingOptions = new RateLimitingMiddlewareOptions
{
    RequestsPerMinute = 200,
    LimitExceedErrorMessage = "You have exceeded the rate limit."
};
app.UseRateLimiting(services, rateLimitingOptions);

Cross-Origin Resource Sharing (CORS) Middleware

With Custom Options

var corsOptions = new CorsMiddlewareOptions
{
    AllowOrigin = "*" ,
    AllowMethods = "GET, POST",
    AllowHeaders = "Content-Type, Authorization"
};
app.UseCors(services, corsOptions);

Using Configuration

app.UseCors(services, configuration);

XSS Protection Middleware

app.UseXssProtection();

Contributing

We welcome contributions! Please check the contributing guidelines for more details.

License

This project is licensed under the MIT License. See the LICENSE file for details.