Grape::Attack 项目教程

Grape::Attack 项目教程

grape-attack A middleware for Grape to add endpoint-specific throttling. 项目地址: https://gitcode.com/gh_mirrors/gr/grape-attack

1. 项目目录结构及介绍

Grape::Attack 是一个用于 Grape API 的中间件，用于添加端点特定的限流功能。以下是项目的目录结构及其介绍：

grape-attack/
├── bin/
│   └── setup
├── lib/
│   └── grape/
│       └── attack/
│           ├── adapter.rb
│           ├── configuration.rb
│           ├── middleware.rb
│           ├── rate_limit.rb
│           └── version.rb
├── spec/
│   ├── grape/
│   │   └── attack/
│   │       ├── adapter_spec.rb
│   │       ├── configuration_spec.rb
│   │       ├── middleware_spec.rb
│   │       └── rate_limit_spec.rb
│   └── spec_helper.rb
├── .gitignore
├── .rspec
├── .travis.yml
├── CHANGELOG.md
├── Gemfile
├── LICENSE.txt
├── README.md
├── Rakefile
└── grape-attack.gemspec

目录结构介绍

• bin/: 包含项目的设置脚本 setup。
• lib/grape/attack/: 包含 Grape::Attack 的核心代码，包括适配器、配置、中间件和限流逻辑。
• spec/: 包含项目的测试文件，用于测试各个模块的功能。
• .gitignore: Git 忽略文件列表。
• .rspec: RSpec 配置文件。
• .travis.yml: Travis CI 配置文件。
• CHANGELOG.md: 项目更新日志。
• Gemfile: 项目的依赖管理文件。
• LICENSE.txt: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• Rakefile: Rake 任务配置文件。
• grape-attack.gemspec: 项目的 gemspec 文件，定义了 gem 的元数据和依赖。

2. 项目的启动文件介绍

Grape::Attack 是一个中间件，通常不需要单独的启动文件。它通过在 Grape API 中挂载中间件来启用。以下是一个简单的示例：

class MyApi < Grape::API
  use Grape::Attack::Throttle

  resources :comments do
    throttle max: 10, per: 1.minute
    get do
      Comment.all
    end
  end
end

在这个示例中，use Grape::Attack::Throttle 挂载了限流中间件，并通过 throttle DSL 定义了端点的限流规则。

3. 项目的配置文件介绍

Grape::Attack 的配置主要通过代码进行，没有独立的配置文件。配置可以通过以下方式进行：

3.1 限流规则配置

通过 throttle DSL 配置每个端点的限流规则：

throttle max: 10, per: 1.minute

• max: 允许的最大请求数。
• per: 限流的时间窗口，可以使用 ActiveSupport 的时间扩展。

3.2 自定义标识符

可以通过 identifier 参数传递自定义的标识符：

throttle max: 100, per: 1.day, identifier: Proc.new { [current_user.id] }

3.3 异常处理

当达到限流时，会抛出 Grape::Attack::RateLimitExceededError 异常，可以通过 rescue_from 捕获并处理：

rescue_from Grape::Attack::RateLimitExceededError do |e|
  error!({ message: e.message }, 403)
end

3.4 适配器配置

Grape::Attack 使用适配器来存储限流计数器。目前仅支持 Redis 适配器，可以通过环境变量 REDIS_URL 配置 Redis 连接：

ENV['REDIS_URL'] = 'redis://localhost:6379/0'

总结

Grape::Attack 是一个简单易用的 Grape API 限流中间件，通过代码配置限流规则和适配器，适用于需要对 API 端点进行限流控制的场景。

grape-attack A middleware for Grape to add endpoint-specific throttling. 项目地址: https://gitcode.com/gh_mirrors/gr/grape-attack