rogervila/lumen-rate-limiting

Lumen port of Laravel ThrottleRequests middleware

Maintainers

Details

github.com/rogervila/lumen-rate-limiting

Source

Issues

Installs: 37 326

Dependents: 1

Suggesters: 0

Security: 0

Stars: 16

Watchers: 3

Forks: 2

Open Issues: 1

2.0.0 2024-06-03 09:54 UTC

Requires

Requires (Dev)

MIT e4dcd46ceebfd6fc647405de0a7ba01f076c8dc1

  • Roger Vilà <rogervila.woop@me.com>

laravelRatelumenlimiter

This package is auto-updated.

Last update: 2024-11-03 10:53:58 UTC

README

Lumen Rate limiting

Total Downloads Latest Stable Version License

About

This package contains a Lumen port of Laravel's ThrottleRequests middleware.

Check the package version compatibility based on your Lumen's project version:

Install

  1. Require the package on your Lumen application
composer require rogervila/lumen-rate-limiting
  1. Make sure that AppServiceProvider and AuthServiceProvider are uncommented on bootstrap/app.php
$app->register(App\Providers\AppServiceProvider::class);
$app->register(App\Providers\AuthServiceProvider::class);
  1. Configure a rate limiter on the AppServiceProvider boot method
/**
 * Configure global rate limiter
 *
 * @return void
 */
public function boot()
{
    app(\Illuminate\Cache\RateLimiter::class)->for('global', function () {
        return \Illuminate\Cache\RateLimiting\Limit::perMinute(60)->by(request()->ip());
    });
}
  1. Register the middleware on bootstrap/app.php
$app->routeMiddleware([
    'throttle' => \LumenRateLimiting\ThrottleRequests::class,
]);
  1. Add the middleware to the global router group on bootstrap/app.php
$app->router->group([
    'namespace' => 'App\Http\Controllers',
    'middleware' => 'throttle:global',
], function ($router) {
    require __DIR__ . '/../routes/web.php';
});

The middleware can be placed on specific routes instead of globally, as defined on the official documentation.

License

This project is open-sourced software licensed under the MIT license.