NAME

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

SYNOPSIS

package Foo::Controller::Bar;

__PACKAGE__->config(
    'default'   => 'text/x-yaml',
    'stash_key' => 'rest',
    'map'       => {
        'text/html'          => [ 'View', 'TT', ],
        '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 HTTP Requests content-type header.

It requires that your Catalyst controller is properly configured to set up the mapping between Content Type's and Serialization classes.

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

Typically, you would use this ActionClass on your end method. However, nothing is stopping you from choosing specific methods to Serialize:

sub foo :Local :ActionClass('Serialize') {
   .. populate stash with data ..
}

When you use this module, the request class will be changed to Catalyst::Request::REST.

CONFIGURATION

default

The Content-Type of the default Serialization format. This must be a Content-Type associated with a plugin in the "map" section below.

This is used if a requested content-type is not recognized.

stash_key

We will serialize the data that lives in this location in the stash. So if the value is "rest", we will serialize the data under:

$c->stash->{'rest'}

map

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

HELPFUL PEOPLE

Daisuke Maki pointed out that early versions of this Action did not play well with others, or generally behave in a way that was very consistent with the rest of Catalyst.

SEE ALSO

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

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.