phapi/middleware-uuid

This package is abandoned and no longer maintained. No replacement package was suggested.

Phapi UUID middleware generates and adds UUID to request and response for easier debugging.

1.0.0 2015-07-02 11:34 UTC

This package is not auto-updated.

Last update: 2021-02-05 22:35:14 UTC


README

Build status Code Climate Test Coverage

The Phapi UUID Middleware generates an UUID (version 4) and adds it to the request object (as an attribute) and as a header to the response object. This makes it easier to debug problems as the client can refer to an UUID when contacting the API provider for help. If the UUID is used while logging it's easier for the provider to find the important information in the logs.

Installation

This middleware is by default included in the Phapi Framework but if you need to install it it's available to install via Packagist and Composer.

$ php composer.phar require phapi/middleware-uuid:1.*

Configuration

The middleware itself does not have any configuration options.

See the configuration documentation for more information about how to configure the integration with the Phapi Framework.

Usage

<?php
// Get the attribute from the request
$uuid = $request->getAttribute('uuid', null);

// Get header from response
$uuid = $response->getHeaderLine('uuid');

Phapi

This middleware is a Phapi package used by the Phapi Framework. The middleware are also PSR-7 compliant and implements the Phapi Middleware Contract.

License

Serializer JSON is licensed under the MIT License - see the license.md file for details

Contribute

Contribution, bug fixes etc are always welcome.