Package for working with API requests and responses in different formats
This package is auto-updated.
Last update: 2022-04-29 01:13:24 UTC
Use Composer to install the package in your project:
composer require eoneopay/apiformats
By default the package handle JSON (application/json) and XML (application/xml, text/xml) formats.
If you want to handle different formats or want to implement your own JSON/XML encoding logic, the only thing
you need to do is creating your encoder implementing
tell the package to use it, with which Mime types as explained in the Configuration section.
That's it! Your application is now able to easily receive requests and generate responses in several formats.
If you want to customise the generated response as its status code or headers without handling
body encoding yourself, the package provides the
object you can return from your controllers/middlewares. The
FormattedApiResponse accept three parameters through its
constructor as following:
- $content (mixed): array or object able to be cast as an array
- $statusCode (int): status code of response, default as 200
- $headers (array): headers of response, default as empty array
The philosophy of the package is to map encoders to a list of MIME types that they can handle through an array as following:
$formats = [ <RequestEncoderInterface> => [<mime_type>, <mime_type>, ...] ];
Each MIME type can be the exact name as
application/json or a Regex
used to match multiple MIME types as
To configure supported formats in your application, create a
api-formats.php config file with a
array using the encoders class as key and array of associated Mime types as value:
// config/api-formats.php return [ 'formats' => [ JsonRequestEncoder::class => ['application/json'], XmlRequestEncoder::class => ['(application|text)/xml'], YourCustomerEncoder::class => ['you-custom-mime-type'] ] ];