Wallogit.com
2017 © Pedro PelĂĄez
Some useful classes for handling certain aspects of a REST(ful) API.
, (*1)
Rest util library for PHP., (*2)
This library implement some useful util classes for resolving recurrent issues in Rest(ful) APIs (i.e: Error handling)., (*3)
Rest utilitary library for PHP, (*4)
Using Composer, just $ composer require tbbc/rest-util package or:, (*5)
``` javascript { "require": { "tbbc/rest-util": "dev-master" } }, (*6)
Usage ----- Converting Exception into Error object: 1\. First you have to define an `ExceptionMapping`, for the sake of the example, we use `PHP`, but a `YamlLoader` is also available: ```php // Exception mapping configuration $invalidArgumentExceptionMapping = new ExceptionMapping(array( 'exceptionClassName' => '\InvalidArgumentException', 'factory' => 'default', 'httpStatusCode' => 400, 'errorCode' => 400101, 'errorMessage' => null, 'errorExtendedMessage' => 'Extended message', 'errorMoreInfoUrl' => 'http://api.my.tld/doc/error/400101', ));
2. The ExceptionMapping must be added to ExceptionMap:, (*7)
$exceptionMap = new ExceptionMap(); $exceptionMap->add($invalidArgumentExceptionMapping);
3. We plug the ErrorResolver with an ErrorFactory, a DefaultErrorFactory is bundled within the lib:, (*8)
// Error resolver initialization $errorResolver = new ErrorResolver($exceptionMap); $defaultErrorFactory = new DefaultErrorFactory(); $errorResolver->registerFactory($defaultErrorFactory);
4. Resolve error!, (*9)
$exception = new \InvalidArgumentException('This is an invalid argument exception');
$error = $errorResolver->resolve($exception);
5. The $error variable is now assigned an ErrorInterface object which implements a toArray() method
to allow easy serialization method of your choice:, (*10)
print_r($error->toArray());
/* will output
Array
(
[http_status_code] => 400
[code] => 400101
[message] => This is an invalid argument exception.
[extended_message] => Extended message
[more_info_url] => http://api.my.tld/doc/error/400101
)
*/
echo json_encode($error->toArray());
/* And voilĂ ! You get a ready to use json normalized error response body
{
"http_status_code": 400,
"code": 400101,
"message": "This is an invalid argument exception.",
"extended_message": "Extended message",
"more_info_url": "http:\/\/api.my.tld\/doc\/error\/400101"
}
*/
For more concrete real life usage, take a look at our bundle for integrating the lib into a Symfony application: TbbcRestUtilBundle., (*11)
First make sure you have installed all the dependencies, run:, (*12)
$ composer install --dev, (*13)
then, run the test from within the root directory:, (*14)
$ vendor/bin/phpunit, (*15)
The Big Brains Company - Rest Util is licensed under the MIT License - see the LICENSE file for details, (*16)
, (*17)
Some useful classes for handling certain aspects of a REST(ful) API.
MIT
api rest restful
Some useful classes for handling certain aspects of a REST(ful) API.
MIT
api rest restful