broken-titan/laravel-idempotency-middleware

Idempotency middleware for Laravel.

v1.1.1 2023-10-05 02:26 UTC

Requires

• php: >=7.4

Requires (Dev)

• mockery/mockery: 1.4.4
• orchestra/testbench: ^6.24
• phpunit/phpunit: 9.5.10

MIT

• Marshall Miller

README

This package makes it easy to add an indempotentcy to Laravel requests.

Contents

• Installation
• Configuration
• Usage
• Testing
• Security
• Contributing
• Credits
• License

Installation

Install this package with Composer:

composer require broken-titan/laravel-idempotency-middleware

Configuration

There are three configuration values in use which all have defaults. They can be overwritten in config/idempotency.php.

• idempotency.expiration (default: 1440)
• idempotency.header (default: "Idempotency-Key")
• idempotency.methods (default: ["POST"])

You can also pass route-specific parameters in the routes file when setting the middleware.

Usage

For ease of use, it is recommended that you add the middleware in your App\Http\Kernel.php file to $routeMiddleware.

    'idempotency' => \BrokenTitan\Idempotency\Middleware\Idempotency::class

You can set middleware for routes using the standard middleware assignment function.

    Route::apiResource("model", "ModelController", )->middleware("idempotency");

The idempotency middle parameters can be set on a per-route basis, overriding the configuration default.

    Route::apiResource("model", "ModelController", )->middleware("idempotency:X-Custom-Header,POST,100");

Testing

A Docker compose file is included that allows you to run tests for this package.

Security

If you discover any security issues that would affect existing users, please email [e-mail] instead of using the issue tracker.

Contributing

Feel free to contribute to the package.

License

The MIT License (MIT). Please see License File for more information.