WebApiThrottle 使用教程

WebApiThrottle 使用教程

项目介绍

WebApiThrottle 是一个用于 ASP.NET Web API 的限流框架，旨在控制客户端对 API 的请求速率。它支持 IIS 和 OWIN 托管环境，并提供了灵活的限流策略配置，可以根据 IP 地址、客户端 API 密钥和请求路由进行限流。

项目快速启动

安装 WebApiThrottle

首先，通过 NuGet 安装 WebApiThrottle 包：

dotnet add package WebApiThrottle --version 1.5.4

配置限流策略

在 WebApiConfig.cs 文件中配置限流策略：

using WebApiThrottle;

public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        config.MessageHandlers.Add(new ThrottlingHandler()
        {
            Policy = new ThrottlePolicy(
                perSecond: 1, // 每秒限制次数
                perMinute: 20, // 每分钟限制次数
                perHour: 200, // 每小时限制次数
                perDay: 1500, // 每天限制次数
                perWeek: 3000 // 每周限制次数
            )
            {
                IpThrottling = true, // 启用 IP 限制
                ClientThrottling = true // 启用客户端限制
            },
            Repository = new CacheRepository()
        });
    }
}

启动项目

确保你的 Web API 项目已经配置好并运行。此时，WebApiThrottle 将开始根据配置的策略限制请求速率。

应用案例和最佳实践

应用案例

假设你有一个公共 API，需要限制每个 IP 地址每分钟最多请求 10 次。你可以这样配置：

config.MessageHandlers.Add(new ThrottlingHandler()
{
    Policy = new ThrottlePolicy(
        perMinute: 10
    )
    {
        IpThrottling = true
    },
    Repository = new CacheRepository()
});

最佳实践

1. 动态配置限流策略：根据实际需求动态调整限流策略，避免过度限制或限制不足。
2. 日志记录：记录被限流的请求，便于后续分析和优化。
3. 多层限流：结合 IP 地址、客户端 API 密钥等多层限流策略，提高安全性。

典型生态项目

WebApiThrottle 可以与其他 ASP.NET Web API 生态项目结合使用，例如：

1. IdentityServer：用于 API 的身份验证和授权。
2. Serilog：用于日志记录，方便监控和分析限流情况。
3. Swashbuckle：用于生成 API 文档，方便开发者理解和使用 API。

通过这些生态项目的结合，可以构建一个安全、高效、易用的 Web API 服务。