denismitr/etag

Etag Middleware for Laravel

v2.1.0 2020-02-15 21:00 UTC

Requires

• php: ^7.2
• ext-json: *
• illuminate/support: 5.8.*|^6.0

Requires (Dev)

• mockery/mockery: ^1.2.1
• orchestra/testbench: 3.8.*|^4.0
• phpunit/phpunit: ^7.5|^8.0

MIT

• Denis Mitrofanov

• http
• response
• middleware
• request
• laravel
• Etag
• ETags
• not-modified

README

This a middleware specifically for the Laravel framework and RESTful APIs build with it. It hashaes the response content and adds it to ETag header of HTTP response. Then it listenes to If-Match and If-None-Match headers of the requests that expect to receive json in response in order to see if a new content needs to be delivered or just 304 Not Modified response is sufficient.

Author

Denis Mitrofanov

TheCollection.ru

Installation

Use composer to install the package:

composer require denismitr/etag

Include in your app/Http/Kernel.php to the appropriate section (all requests if all your routes are API or named middleware + API middleware group to make it work for every api route or just named middleware):

Global middleware

/**
 * The application's global HTTP middleware stack.
 *
 * These middleware are run during every request to your application.
 *
 * @var array
 */
protected $middleware = [
    ...
    \Denismitr\ETags\ETagMiddleware::class
];

Named middleware

/**
 * The application's route middleware.
 *
 * These middleware may be assigned to groups or used individually.
 *
 * @var array
 */
protected $routeMiddleware = [
    ...
    'etag' => \Denismitr\ETags\ETagMiddleware::class,
];

/**
 * The application's route middleware groups.
 *
 * @var array
 */
protected $middlewareGroups = [
    'web' => [
        ...
    ],

    'api' => [
        ...
        'etag'
    ],
];