The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Catalyst::Action::Serialize - Serialize Data in a Response

SYNOPSIS

package Foo::Controller::Bar;

__PACKAGE__->config(
    serialize => {
        'default'   => 'YAML',
        'stash_key' => 'rest',
        'map'       => {
            'text/x-yaml'        => 'YAML',
            'text/x-data-dumper' => [ 'Data::Serializer', 'Data::Dumper' ],
        },
    }
);

sub end : ActionClass('Serialize') {}

DESCRIPTION

This action will serialize the body of an HTTP Response. The serializer is selected by introspecting the requests content-type header.

It requires that your Catalyst controller have a "serialize" entry in it's configuration.

The specifics of serializing each content-type is implemented as a plugin to Catalyst::Action::Serialize.

CONFIGURATION

default

The default Serialization format. See the next section for available options. This is used if a requested content-type is not recognized.

stash_key

Where in the stash the data you want serialized lives.

map

Takes a hashref, mapping Content-Types to a given plugin.

SEE ALSO

You likely want to look at Catalyst::Controller::REST, which implements a sensible set of defaults for a controller doing REST.

Catalyst::Action::Deserialize, Catalyst::Action::REST

AUTHOR

Adam Jacob <adam@stalecoffee.org>, with lots of help from mst and jrockway

Marchex, Inc. paid me while I developed this module. (http://www.marchex.com)

LICENSE

You may distribute this code under the same terms as Perl itself.