softonic / laravel-middleware-request-id
Middleware for Laravel Framework to add the X-Request-ID header in the requests and responses.
Installs: 92 312
Dependents: 0
Suggesters: 0
Security: 0
Stars: 15
Watchers: 8
Forks: 3
Open Issues: 0
Requires
- php: >=7.4
- illuminate/http: >7.0
- ramsey/uuid: ^4.0.0
Requires (Dev)
- phpunit/phpunit: ^9.0
This package is auto-updated.
Last update: 2024-10-28 22:19:35 UTC
README
Install
$ composer require softonic/laravel-middleware-request-id
Usage
For all routes or a specific group
Add Softonic\Laravel\Middleware\RequestId::class
in App\Http\Kernel
.
For all routes:
protected $middleware = [ \Softonic\Laravel\Middleware\RequestId::class, .... ]
Specific group:
// Example for WEB group protected $middlewareGroups = [ 'web' => [ \Softonic\Laravel\Middleware\RequestId::class, ... ], 'api' => [ ... ], ];
For a specific route
Register the middleware as a route middleware in App\Http\Kernel
.
protected $routeMiddleware = [ ... 'request-id' => Softonic\Laravel\Middleware\RequestId::class, ];
then, use it in your routes file, for example in routes\web.php
Route::get('route', function() {})->middleware('request-id');
Extra
If you need to have the X-Request-Id ASAP, you can modify \App\Providers\AppServiceProvider::boot
adding $_SERVER['HTTP_X_REQUEST_ID'] ??= \Ramsey\Uuid\Uuid::uuid4()->toString();
.
This is going to allow you to use the X-Request-ID in the framework booting to for example customize monolog or in console executions.