Laravel Idempotency Middleware
Install
Require this package with composer using the following command:
composer require revangelista/laravel-idempotency
Usage
Register Idempotency middleware on your http kernel file:
'api' => [
'throttle:60,1',
'bindings',
\Idempotency\Idempotency::class,
]
To perform an idempotent request, provide an additional Idempotency-Key: <key> header to the request.
How it works
If the header Idempotency-Key is present on the request and the request method is POST, the middleware stores the response on the cache. Next time you make a request with same idempotency key, the middleware will return the cached response.
How you create unique keys is up to you, it is strongly suggest to use V4 UUIDs or another appropriately random string. It'll always send back the same response for requests made with the same key, and keys can't be reused with different request parameters. Keys expire after 24 hours.
To personalise the idempotency header name and the key expiration, publish config file:
php artisan vendor:publish --provider "Idempotency\IdempotencyServiceProvider"
And specify in the .env file like this:
IDEMPOTENCY_HEADER="My-Custom-Idempotency-Key",
IDEMPOTENCY_EXPIRATION=1440 #in minutes
Learn more about Idempotency.
License
The Laravel Idempotency is open-sourced software licensed under the MIT license
1 Oct 29, 2021
8 Oct 25, 2022
372 Nov 21, 2022
5.2k Nov 17, 2021
3.3k Dec 22, 2022
18 Sep 8, 2022
2 Dec 23, 2022
997 Dec 22, 2022
56 Dec 12, 2022
1.5k Dec 29, 2022
5.4k Jan 4, 2023
1.8k Jan 3, 2023
903 Dec 31, 2022
1k Jan 3, 2023
5 Sep 21, 2022
134 Jan 2, 2023
56 Jul 17, 2022