Level 54
perhaps the name may different, try inspect the response data... https://medium.com/@guillaume.viguierjust/rate-limiting-your-restful-api-3148f8e77248
May 19, 2022
5
Level 2
Trying to log API throttling
Been giving a task to put some information in the logs when a client hits their throttle limit. Have had some success making these changes in class RouteServiceProvider.php. The problem I'm facing now is that the response is missing the X-RateLimit* headers. Does anyone know how those headers are set? The getHeaders function in the ThrottleRequests appears to create the headers I need, but I'm not sure how to get the info for the function parameters.
protected function configureRateLimiting()
{
RateLimiter::for(
'api',
fn (Request $request) => Limit::perMinute(60)
->by(optional($request->user())->id ?: $request->ip())
->response(function () {
Log::info('DEBUG: Put throttle info here');
abort(429, "Too Many Attempts.");
})
);
}`
Level 2
@siangboon I was inspecting my response data, that's how I knew I had a problem. :) Thanks to the other answer I now know what parameters the callback function will be called with. Now I can include the headers created by the ThrottleRequests class.
Level 50
use Illuminate\Http\Exceptions\ThrottleRequestsException;
protected function configureRateLimiting()
{
RateLimiter::for(
'api',
fn (Request $request) => Limit::perMinute(60)
->by(optional($request->user())->id ?: $request->ip())
->response(function ($request, $headers) {
Log::info('DEBUG: Put throttle info here');
abort(429, "Too Many Attempts.", $headers);
});
);
}`
1 like
Level 2
@Niush Thank you. That gives me the headers I need to send in my response. I was digging through RateLimit, Limit, ThrottleRequests and ThrottleRequestsException but didn't see the solution. With your answer I finally understand where the callback is being used and that it will be called the $request and $header as parameters.
Level 2
I made a PR to the Laravel docs to include the 2 parameters.
Please or to participate in this conversation.