Rack Middleware API限流技术文档

1. 安装指南

此限流中间件已封装成gem，可以使用以下命令安装最新版：

sudo gem install jduff-api-throttling

如果需要使用最新源码，可以在GitHub上找到：jduff/api-throttling（这是dambalah/api-throttling的分支，包含了近期的一些改动）。

2. 项目使用说明

在Rack应用中，只需使用中间件并传递一些选项即可：

use ApiThrottling, :requests_per_hour => 3

这将设置每小时最多3次请求的限流，并使用Redis缓存来追踪。默认情况下，Rack::Auth::Basic用于基于每个用户进行请求限制。

中间件还支持以下选项：

• :cache=>:redis：支持:memcache, :hash。也可以传入这些缓存的实例，或者使用Rails.cache。
• :auth=>false：如果你的中间件在其他地方进行了认证，可以设置此项。
• :key：自定义缓存键的生成方式。

使用所有选项的示例：

CACHE = MemCache.new
use ApiThrottling, :requests_per_hour => 100, :cache=>CACHE, :auth=>false, 
                    :key=>Proc.new{|env,auth| "#{env['PATH_INFO']}_#{Time.now.strftime("%Y-%m-%d-%H")}" }

这将限制每个URL每小时100次请求，使用MemCache来存储计数。

3. 项目API使用文档

项目API主要是通过中间件进行调用，以下为中间件的API使用方法：

class ApiThrottling
  def initialize(app, options={})
    # 初始化方法，设置应用和选项
  end
  
  def call(env, options={})
    # 调用方法，处理请求并应用限流逻辑
  end
  
  private
  
  def bad_request
    # 生成400 Bad Request响应
  end
  
  def over_rate_limit
    # 生成503 Over Rate Limit响应
  end
end

4. 项目安装方式

基础Rack应用安装

首先，确保安装了thin webserver：

sudo gem install thin

然后使用以下基础Rack应用进行测试：

use Rack::ShowExceptions
use Rack::Lint

run lambda {|env| [200, { 'Content-Type' => 'text/plain', 'Content-Length' => '12'}, ["Hello World!"] ] }

将代码保存为config.ru文件，并使用以下命令启动thin服务器：

thin --rackup config.ru start

现在可以使用以下命令测试服务是否正常运行：

curl -i http://localhost:3000

Redis安装

为了记录请求次数，需要安装Redis并使用其Ruby客户端库：

sudo gem install ezmobius-redis-rb

确保Redis服务器运行在默认端口6379上。

使用限流中间件

最后，在你的Rack应用中引入并配置限流中间件：

require 'api_throttling'

use Rack::Lint
use Rack::ShowExceptions
use ApiThrottling, :requests_per_hour => 3

run lambda {|env| [200, {'Content-Type' => 'text/plain', 'Content-Length' => '12'}, ["Hello World!"] ] }

现在，你可以尝试使用curl测试API，直到达到限流设置的限制。