README

The YAML Serializer package contains two middleware, one for serialization and one for deserialization. The two works the same the only difference is that the serializer takes an array and returns YAML and the deserializer does the opposite.

The serializer reacts if the Accept header matches one of the supported mime types and the deserializer reacts if the Content-Type matches the list of supported mime types.

By default the supported mime types are: application/x-yaml, text/x-yaml and text/yaml. It is possible to add more mime types by passing an array to the constructor.

Installation

This middleware is not included by default 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/serializer-yaml:1.*

Configuration

Both the serializer and deserializer has one configuration option, it's possible to add more mime types that should trigger the serializer/deserializer.

<?php
use Phapi\Middleware\Serializer\Yaml\Yaml;

$pipeline->pipe(new Yaml(['text/html']));

Note that the array passed to the constructor will be merged with the default settings.

The above instructions applies to the deserializer as well.

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

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 YAML is licensed under the MIT License - see the license.md file for details

Contribute

Contribution, bug fixes etc are always welcome.

phapi / serializer-yaml

Maintainers

Details