README-CN.md

rate-limiter

简体中文 | ENGLISH

Provides a Token Bucket implementation to rate limit input and output in your Coole application. - 提供令牌桶实现来限制 Coole 应用程序中的输入和输出。

环境要求

• PHP >= 7.2

安装

$ composer require coolephp/rate-limiter --prefer-dist -vvv

使用

1. 复制 rate-limiter/config/rate-limiter.php 为 coole-skeleton/config/rate-limiter.php.
2. 配置 \Coole\RateLimiter\RateLimiter::class 中间件.

<?php

return [
    /*
     * App 名称
     */
    'name' => env('APP_NAME', 'Coole'),

    /*
     * 全局中间件
     */
    'middleware' => [
        ...
        \Coole\RateLimiter\RateLimiter::class
        ...
    ],
];

测试

$ composer test

变更日志

请参阅 CHANGELOG 获取最近有关更改的更多信息。

贡献指南

请参阅 CONTRIBUTING 有关详细信息。

安全漏洞

请查看我们的安全政策了解如何报告安全漏洞。

贡献者

• guanguans
• 所有贡献者

协议

MIT 许可证（MIT）。有关更多信息，请参见协议文件。