README

A simple package for handling idempotent requests in Laravel.

Any routes using the Replay middleware will check for whether an incoming request meets certain criteria, and if so, it will cache the request for 24 hours so that any subsequent requests will always receive the same response.

Installation

Require Replay using Composer:

composer require kayrunm/replay

Usage

To get started with using Replay, all you need to do is attach the Replay middleware to whichever routes you wish to allow for idempotent requests. For example:

use Kayrunm\Replay\Replay;

Route::post('/account/{account}/transfer', [TransferController::class, 'store'])->middleware(Replay::class);

Configuration

Replay works out-of-the-box, but you can configure it further to fit your needs. To get started, publish the config file with the following command:

php artisan vendor:publish --tag="replay"

Strategies

This package uses the strategy pattern for both determining which requests should be idempotent and for storing their responses in the cache. You can view the default strategies for these below:

If you decide to implement your own strategies for either of the above, simply update the config file with the relevant strategies, for example:

'strategies' => [

    'caching' => \Acme\CustomCacheStrategy::class,
    
    'idempotency' => \Acme\CustomIdempotencyStrategy::class,
    
],

You can also customise the header used for the idempotency key (which is used in DefaultIdempotencyStrategy, which you could change to use a query parameter, if you wished), as well as how long an idempotent request should stay in the cache (which is used in DefaultCacheStrategy)

Licence

Replay is an open-sourced software licensed under the MIT license.

kayrunm / replay

Maintainers

Details