Fixed and improvements

javiereguiluz · javiereguiluz · commit f0c7b061dbf0 · 2020-10-22T13:29:22.000+02:00
diff --git a/rate_limiter.rst b/rate_limiter.rst
@@ -219,15 +219,16 @@ When using a rate limiter in APIs, it's common to include some standard HTTP
 headers in the response to expose the limit status (e.g. remaining tokens, when
 new tokens will be available, etc.)
 
-That's why the ``consume()`` object returns a :class:`Symfony\\Component\\RateLimiter\\RateLimit`
-object which you can use to get the value of those HTTP headers::
+Use the :class:`Symfony\\Component\\RateLimiter\\RateLimit` object returned by
+the ``consume()`` method (also available via the ``getRateLimit()`` method of
+the :class:`Symfony\\Component\\RateLimiter\\Reservation` object returned by the
+``reserve()`` method) to get the value of those HTTP headers::
 
     // src/Controller/ApiController.php
     namespace App\Controller;
 
     use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
     use Symfony\Component\HttpFoundation\Response;
-    use Symfony\Component\HttpKernel\Exception\TooManyRequestsHttpException;
     use Symfony\Component\RateLimiter\RateLimiter;
 
     class ApiController extends AbstractController
@@ -236,18 +237,20 @@ object which you can use to get the value of those HTTP headers::
         {
             $limiter = $anonymousApiLimiter->create($request->getClientIp());
             $limit = $limiter->consume();
+            $headers = [
+                'X-RateLimit-Remaining' => $limit->getRemainingTokens(),
+                'X-RateLimit-Retry-After' => $limit->getRetryAfter()->getTimestamp(),
+                'X-RateLimit-Limit' => $limit->getLimit(),
+            ];
+
             if (false === $limit->isAccepted()) {
-                throw new TooManyRequestsHttpException();
+                return new Response(null, Response::HTTP_TOO_MANY_REQUESTS, $headers);
             }
 
             // ...
 
-            $reponse = new Response($responseContents);
-            $response->headers->add([
-                'X-RateLimit-Remaining' => $limit->getRemainingTokens(),
-                'X-RateLimit-Reset' => $limit->getRetryAfter()->getTimestamp(),
-                'X-RateLimit-Limit' => $limit->getLimit(),
-            ]);
+            $reponse = new Response('...');
+            $response->headers->add($headers);
 
             return $response;
         }
