mirror of
https://github.com/alrayyes/wiki.git
synced 2024-11-22 19:46:23 +00:00
59 lines
1.4 KiB
Markdown
59 lines
1.4 KiB
Markdown
---
|
|
id: 0d182ea8-7df0-4167-a0ae-5710708fb7d1
|
|
title: Symfony RateLimiter Component
|
|
---
|
|
|
|
# Description
|
|
|
|
Introduced in [Symfony 5.2](20201117095953-symfony_5_2). See
|
|
documentation[^1]
|
|
|
|
# Syntax
|
|
|
|
``` yaml
|
|
# config/packages/rate_limiter.yaml
|
|
framework:
|
|
rate_limiter:
|
|
anonymous_api:
|
|
strategy: fixed_window
|
|
limit: 60
|
|
interval: '60 minutes'
|
|
```
|
|
|
|
``` php
|
|
// src/Controller/ApiController.php
|
|
namespace App\Controller;
|
|
|
|
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
|
|
use Symfony\Component\HttpKernel\Exception\TooManyRequestsHttpException;
|
|
use Symfony\Component\RateLimiter\Limiter;
|
|
|
|
class ApiController extends AbstractController
|
|
{
|
|
// the variable name must be: "rate limiter name" + "limiter" suffix
|
|
public function index(Limiter $anonymousApiLimiter)
|
|
{
|
|
// create a limiter based on the client's IP address
|
|
// (you can also use a username/email, an API key, etc.)
|
|
$limiter = $anonymousApiLimiter->create($request->getClientIp());
|
|
|
|
// try to consume a resource; if it's accepted, serve the request
|
|
// otherwise, return a 429 (Too Many Requests) error
|
|
if (false === $limiter->consume()->isAccepted()) {
|
|
throw new TooManyRequestsHttpException();
|
|
}
|
|
|
|
// ...
|
|
}
|
|
|
|
// ...
|
|
}
|
|
```
|
|
|
|
# Used by
|
|
|
|
- [Login Throttling](20201117114036-login_throttling)
|
|
|
|
# Footnotes
|
|
|
|
[^1]: <https://github.com/symfony/symfony-docs/blob/5.x/rate_limiter.rst>
|