An open API service indexing awesome lists of open source software.

https://github.com/softonic/laravel-middleware-request-id


https://github.com/softonic/laravel-middleware-request-id

Last synced: 5 months ago
JSON representation

Awesome Lists containing this project

README

          

# softonic/laravel-middleware-request-id
[![Build Status](https://travis-ci.org/softonic/laravel-middleware-request-id.svg?branch=master)](https://travis-ci.org/softonic/laravel-middleware-request-id)

## Install

```bash
$ 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:
```php
protected $middleware = [
\Softonic\Laravel\Middleware\RequestId::class,
....
]
```

Specific group:
```php
// 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`.
```php
protected $routeMiddleware = [
...
'request-id' => Softonic\Laravel\Middleware\RequestId::class,
];
```

then, use it in your routes file, for example in `routes\web.php`
```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.