RateLimit 1.0.1

dotnet add package RateLimit --version 1.0.1                
NuGet\Install-Package RateLimit -Version 1.0.1                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="RateLimit" Version="1.0.1" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add RateLimit --version 1.0.1                
#r "nuget: RateLimit, 1.0.1"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install RateLimit as a Cake Addin
#addin nuget:?package=RateLimit&version=1.0.1

// Install RateLimit as a Cake Tool
#tool nuget:?package=RateLimit&version=1.0.1                

Author: Khoi Tran

Package: RateLimit

The lightweight .NET Framework package provides a middleware service to protect your application by limiting the request rate. If an IpAddress contains the number of requests which cross over the MaxRequestPerPeriod, it will be blocked by returning a TooManyRequest(429) (config by BlockMessage) within the blocking time (config by BlockTimeSecond)

Installation

nuget install RateLimit

Usage

  • Global.asax.cs: regis global default RateLimit configuration
/// ...
using RateLimit; // use RateLimit package
using RateLimit.Configs;  // use RateLimit package configuration

namespace WebMVC
{
    public class MvcApplication : System.Web.HttpApplication
    {
        protected void Application_Start()
        {
            /// ...
            
            /* 
             * Default configuration using HttpRuntime (Memory cache and Redis are support too)
             * Expand the RedisConfig, MemoryConfig or HttpRuntimeConfig to see more 
             */
            RateLimitContext.RegisterConfig();
        }
    }
}
  • ExampleController.cs: config RateLimitAttribute for GetReport action
using Newtonsoft.Json;
using System.Web.Mvc;
using RateLimit; // use RateLimit package

namespace WebMVC.Controllers
{
    public class ExampleController : Controller
    {
        /* Config for every request come to this action */
        [RateLimit(PeriodTime = 10, MaxRequestPerPeriod = 1, BlockTime = 10, BlockMessage = "You are making too many request")]
        public string GetReport(string param1)
        {
            return param1;
        }
    }
}

Advance

  • Global.asax.cs: custom regis global default RateLimit configuration
/// ...
using RateLimit; // use RateLimit package
using RateLimit.Configs;  // use RateLimit package configuration

namespace WebMVC
{
    public class MvcApplication : System.Web.HttpApplication
    {
        protected void Application_Start()
        {
            /// ...
            /// ...
            
            /* Full global config */ 
            RateLimitContext.RegisterConfig(
                new RateLimitConfig(
                    /* Global config for request rate */
                    rateConfig: new RequestRateConfig
                    {
                        BlockMessage = "You are making too many request, please try after 60 second",
                        BlockTime = 60,
                        CookieName = "ASP.NET_SessionId",
                        MaxRequestPerPeriod = 1,
                        PeriodTime = 10
                    },
                    /* Cache config, default is new HttpRuntimeConfig() */
                    cacheConfig: new RedisConfig()
                    {
                        CacheTimeSecond = 3600,
                        ConnectTimeoutSecond = 5,
                        DatabaseIndex = 0,
                        EndPoints = "localhost:6379"
                    }
                )
            );
        }
    }
}
  • ExampleController.cs: Use default global rate configuration
/// ...
using RateLimit; // use RateLimit package

namespace WebMVC.Controllers
{
    public class ExampleController : Controller
    {
        /* Use default global rate configuration */
        [RateLimit]
        public string GetReport(string param1)
        {
            return param1;
        }
    }
}
Product Compatible and additional computed target framework versions.
.NET Framework net45 is compatible.  net451 was computed.  net452 was computed.  net46 was computed.  net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.1 629 12/4/2022
1.0.0 183 12/4/2022

Add static .dll