Dancer2::Serializer::Mutable - Serialize and deserialize content based on HTTP header
version 0.400000
# in config.yml serializer: Mutable engines: serializer: Mutable: mapping: 'text/x-yaml' : YAML 'text/html' : YAML 'text/x-data-dumper' : Dumper 'text/x-json' : JSON 'application/json' : JSON # in the app put '/something' => sub { # deserialized from request my $name = param( 'name' ); ... # will be serialized to the most # fitting format return { message => "user $name added" }; };
This serializer will try find the best (de)serializer for a given request. For this, it will pick the first valid content type found from the following list and use its related serializer.
The content_type from the request headers
the accept from the request headers
The default is application/json
The content-type/serializer mapping that Dancer2::Serializer::Mutable uses is
Dancer2::Serializer::Mutable
serializer | content types ---------------------------------------------------------- Dancer2::Serializer::YAML | text/x-yaml, text/html Dancer2::Serializer::Dumper | text/x-data-dumper Dancer2::Serializer::JSON | text/x-json, application/json
A different mapping can be provided via the config file. For example, the default mapping would be configured as
engines: serializer: Mutable: mapping: 'text/x-yaml' : YAML 'text/html' : YAML 'text/x-data-dumper' : Dumper 'text/x-json' : JSON 'application/json' : JSON
The keys of the mapping are the content-types to serialize, and the values the serializers to use. Serialization for YAML, Dumper and JSON are done using internal Dancer mechanisms. Any other serializer will be taken to be as Dancer2 serialization class (minus the Dancer2::Serializer:: prefix) and an instance of it will be used to serialize/deserialize data. For example, adding Dancer2::Serializer::XML to the mapping would be:
YAML
Dumper
JSON
Dancer2::Serializer::
engines: serializer: Mutable: mapping: 'text/x-yaml' : YAML 'text/html' : YAML 'text/x-data-dumper' : Dumper 'text/x-json' : JSON 'text/xml' : XML
The following methods are used internally by Dancer2 and are not made accessible via the DSL.
Dancer2
Serialize a data structure. The format it is serialized to is determined automatically as described above. It can be one of YAML, Dumper, JSON, defaulting to JSON if there's no clear preference from the request.
Deserialize the provided serialized data to a data structure. The type of serialization format depends on the request's content-type. For now, it can be one of YAML, Dumper, JSON.
Returns the content-type that was used during the last serialize / deserialize call. WARNING : you must call serialize / deserialize before calling content_type. Otherwise the return value will be undef.
serialize
deserialize
content_type
undef
Dancer Core Developers
This software is copyright (c) 2022 by Alexis Sukrieh.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install Dancer2, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Dancer2
CPAN shell
perl -MCPAN -e shell install Dancer2
For more information on module installation, please visit the detailed CPAN module installation guide.