1 package Catalyst::Controller::REST;
3 our $VERSION = '0.67_01';
7 Catalyst::Controller::REST - A RESTful controller
11 package Foo::Controller::Bar;
13 use base 'Catalyst::Controller::REST';
15 sub thing : Local : ActionClass('REST') { }
17 # Answer GET requests to "thing"
19 my ( $self, $c ) = @_;
21 # Return a 200 OK, with the data in entity
22 # serialized in the body
27 foo => 'is real bar-y',
32 # Answer PUT requests to "thing"
39 Catalyst::Controller::REST implements a mechanism for building
40 RESTful services in Catalyst. It does this by extending the
41 normal Catalyst dispatch mechanism to allow for different
42 subroutines to be called based on the HTTP Method requested,
43 while also transparently handling all the serialization/deserialization for
46 This is probably best served by an example. In the above
47 controller, we have declared a Local Catalyst action on
48 "sub thing", and have used the ActionClass('REST').
50 Below, we have declared "thing_GET" and "thing_PUT". Any
51 GET requests to thing will be dispatched to "thing_GET",
52 while any PUT requests will be dispatched to "thing_PUT".
54 Any unimplemented HTTP methods will be met with a "405 Method Not Allowed"
55 response, automatically containing the proper list of available methods. You
56 can override this behavior through implementing a custom
57 C<thing_not_implemented> method.
59 If you do not provide an OPTIONS handler, we will respond to any OPTIONS
60 requests with a "200 OK", populating the Allowed header automatically.
62 Any data included in C<< $c->stash->{'rest'} >> will be serialized for you.
63 The serialization format will be selected based on the content-type
64 of the incoming request. It is probably easier to use the L<STATUS HELPERS>,
65 which are described below.
67 The HTTP POST, PUT, and OPTIONS methods will all automatically deserialize the
68 contents of $c->request->body based on the requests content-type header.
69 A list of understood serialization formats is below.
71 If we do not have (or cannot run) a serializer for a given content-type, a 415
72 "Unsupported Media Type" error is generated.
74 To make your Controller RESTful, simply have it
76 use base 'Catalyst::Controller::REST';
80 Catalyst::Controller::REST will automatically serialize your
81 responses, and deserialize any POST, PUT or OPTIONS requests. It evaluates
82 which serializer to use by mapping a content-type to a Serialization module.
83 We select the content-type based on:
87 =item B<The Content-Type Header>
89 If the incoming HTTP Request had a Content-Type header set, we will use it.
91 =item B<The content-type Query Parameter>
93 If this is a GET request, you can supply a content-type query parameter.
95 =item B<Evaluating the Accept Header>
97 Finally, if the client provided an Accept header, we will evaluate
98 it and use the best-ranked choice.
102 =head1 AVAILABLE SERIALIZERS
104 A given serialization mechanism is only available if you have the underlying
105 modules installed. For example, you can't use XML::Simple if it's not already
108 In addition, each serializer has it's quirks in terms of what sorts of data
109 structures it will properly handle. L<Catalyst::Controller::REST> makes
110 no attempt to save you from yourself in this regard. :)
114 =item C<text/x-yaml> => C<YAML::Syck>
116 Returns YAML generated by L<YAML::Syck>.
118 =item C<text/html> => C<YAML::HTML>
120 This uses L<YAML::Syck> and L<URI::Find> to generate YAML with all URLs turned
121 to hyperlinks. Only useable for Serialization.
123 =item C<application/json> => C<JSON>
125 Uses L<JSON> to generate JSON output. It is strongly advised to also have
126 L<JSON::XS> installed. The C<text/x-json> content type is supported but is
127 deprecated and you will receive warnings in your log.
129 =item C<text/x-data-dumper> => C<Data::Serializer>
131 Uses the L<Data::Serializer> module to generate L<Data::Dumper> output.
133 =item C<text/x-data-denter> => C<Data::Serializer>
135 Uses the L<Data::Serializer> module to generate L<Data::Denter> output.
137 =item C<text/x-data-taxi> => C<Data::Serializer>
139 Uses the L<Data::Serializer> module to generate L<Data::Taxi> output.
141 =item C<application/x-storable> => C<Data::Serializer>
143 Uses the L<Data::Serializer> module to generate L<Storable> output.
145 =item C<application/x-freezethaw> => C<Data::Serializer>
147 Uses the L<Data::Serializer> module to generate L<FreezeThaw> output.
149 =item C<text/x-config-general> => C<Data::Serializer>
151 Uses the L<Data::Serializer> module to generate L<Config::General> output.
153 =item C<text/x-php-serialization> => C<Data::Serializer>
155 Uses the L<Data::Serializer> module to generate L<PHP::Serialization> output.
157 =item C<text/xml> => C<XML::Simple>
159 Uses L<XML::Simple> to generate XML output. This is probably not suitable
160 for any real heavy XML work. Due to L<XML::Simple>s requirement that the data
161 you serialize be a HASHREF, we transform outgoing data to be in the form of:
163 { data => $yourdata }
167 Uses a regular Catalyst view. For example, if you wanted to have your
168 C<text/html> and C<text/xml> views rendered by TT:
170 'text/html' => [ 'View', 'TT' ],
171 'text/xml' => [ 'View', 'XML' ],
173 Will do the trick nicely.
177 By default, L<Catalyst::Controller::REST> will return a C<415 Unsupported Media Type>
178 response if an attempt to use an unsupported content-type is made. You
179 can ensure that something is always returned by setting the C<default>
182 __PACKAGE__->config->{'default'} = 'text/x-yaml';
184 Would make it always fall back to the serializer plugin defined for text/x-yaml.
186 Implementing new Serialization formats is easy! Contributions
187 are most welcome! See L<Catalyst::Action::Serialize> and
188 L<Catalyst::Action::Deserialize> for more information.
190 =head1 CUSTOM SERIALIZERS
192 If you would like to implement a custom serializer, you should create two new
193 modules in the L<Catalyst::Action::Serialize> and
194 L<Catalyst::Action::Deserialize> namespace. Then assign your new class
195 to the content-type's you want, and you're done.
197 =head1 STATUS HELPERS
199 Since so much of REST is in using HTTP, we provide these Status Helpers.
200 Using them will ensure that you are responding with the proper codes,
201 headers, and entities.
203 These helpers try and conform to the HTTP 1.1 Specification. You can
204 refer to it at: L<http://www.w3.org/Protocols/rfc2616/rfc2616.txt>.
205 These routines are all implemented as regular subroutines, and as
206 such require you pass the current context ($c) as the first argument.
214 use base 'Catalyst::Controller';
215 use Params::Validate qw(SCALAR OBJECT);
217 __PACKAGE__->mk_accessors(qw(serialize));
220 'default_view' => 'REST',
221 'stash_key' => 'rest',
223 'text/html' => 'YAML::HTML',
224 'text/xml' => 'XML::Simple',
225 'text/x-yaml' => 'YAML',
226 'application/json' => 'JSON',
227 'text/x-json' => 'JSON',
228 'text/x-data-dumper' => [ 'Data::Serializer', 'Data::Dumper' ],
229 'text/x-data-denter' => [ 'Data::Serializer', 'Data::Denter' ],
230 'text/x-data-taxi' => [ 'Data::Serializer', 'Data::Taxi' ],
231 'application/x-storable' => [ 'Data::Serializer', 'Storable' ],
232 'application/x-freezethaw' => [ 'Data::Serializer', 'FreezeThaw' ],
233 'text/x-config-general' => [ 'Data::Serializer', 'Config::General' ],
234 'text/x-php-serialization' => [ 'Data::Serializer', 'PHP::Serialization' ],
238 sub begin : ActionClass('Deserialize') { }
242 Returns a "200 OK" response. Takes an "entity" to serialize.
249 radiohead => "Is a good band!",
258 my %p = Params::Validate::validate( @_, { entity => 1, }, );
260 $c->response->status(200);
261 $self->_set_entity( $c, $p{'entity'} );
267 Returns a "201 CREATED" response. Takes an "entity" to serialize,
268 and a "location" where the created object can be found.
272 $self->status_created(
274 location => $c->req->uri->as_string,
276 radiohead => "Is a good band!",
280 In the above example, we use the requested URI as our location.
281 This is probably what you want for most PUT requests.
288 my %p = Params::Validate::validate(
291 location => { type => SCALAR | OBJECT },
292 entity => { optional => 1 },
297 if ( ref( $p{'location'} ) ) {
298 $location = $p{'location'}->as_string;
300 $location = $p{'location'};
302 $c->response->status(201);
303 $c->response->header( 'Location' => $location );
304 $self->_set_entity( $c, $p{'entity'} );
308 =item status_accepted
310 Returns a "202 ACCEPTED" response. Takes an "entity" to serialize.
314 $self->status_accepted(
323 sub status_accepted {
326 my %p = Params::Validate::validate( @_, { entity => 1, }, );
328 $c->response->status(202);
329 $self->_set_entity( $c, $p{'entity'} );
333 =item status_bad_request
335 Returns a "400 BAD REQUEST" response. Takes a "message" argument
336 as a scalar, which will become the value of "error" in the serialized
341 $self->status_bad_request(
343 message => "Cannot do what you have asked!",
348 sub status_bad_request {
351 my %p = Params::Validate::validate( @_, { message => { type => SCALAR }, }, );
353 $c->response->status(400);
354 $c->log->debug( "Status Bad Request: " . $p{'message'} ) if $c->debug;
355 $self->_set_entity( $c, { error => $p{'message'} } );
359 =item status_not_found
361 Returns a "404 NOT FOUND" response. Takes a "message" argument
362 as a scalar, which will become the value of "error" in the serialized
367 $self->status_not_found(
369 message => "Cannot find what you were looking for!",
374 sub status_not_found {
377 my %p = Params::Validate::validate( @_, { message => { type => SCALAR }, }, );
379 $c->response->status(404);
380 $c->log->debug( "Status Not Found: " . $p{'message'} ) if $c->debug;
381 $self->_set_entity( $c, { error => $p{'message'} } );
389 if ( defined($entity) ) {
390 $c->stash->{ $self->{'stash_key'} } = $entity;
397 =head1 MANUAL RESPONSES
399 If you want to construct your responses yourself, all you need to
400 do is put the object you want serialized in $c->stash->{'rest'}.
402 =head1 IMPLEMENTATION DETAILS
404 This Controller ties together L<Catalyst::Action::REST>,
405 L<Catalyst::Action::Serialize> and L<Catalyst::Action::Deserialize>. It should be suitable for most applications. You should be aware that it:
409 =item Configures the Serialization Actions
411 This class provides a default configuration for Serialization. It is currently:
415 'stash_key' => 'rest',
417 'text/html' => 'YAML::HTML',
418 'text/xml' => 'XML::Simple',
419 'text/x-yaml' => 'YAML',
420 'application/json' => 'JSON',
421 'text/x-json' => 'JSON',
422 'text/x-data-dumper' => [ 'Data::Serializer', 'Data::Dumper' ],
423 'text/x-data-denter' => [ 'Data::Serializer', 'Data::Denter' ],
424 'text/x-data-taxi' => [ 'Data::Serializer', 'Data::Taxi' ],
425 'application/x-storable' => [ 'Data::Serializer', 'Storable'
427 'application/x-freezethaw' => [ 'Data::Serializer', 'FreezeThaw'
429 'text/x-config-general' => [ 'Data::Serializer', 'Config::General' ]
431 'text/x-php-serialization' => [ 'Data::Serializer', 'PHP::Serialization' ],
436 You can read the full set of options for this configuration block in
437 L<Catalyst::Action::Serialize>.
439 =item Sets a C<begin> and C<end> method for you
441 The C<begin> method uses L<Catalyst::Action::Deserialize>. The C<end>
442 method uses L<Catalyst::Action::Serialize>. If you want to override
443 either behavior, simply implement your own C<begin> and C<end> actions
446 my Foo::Controller::Monkey;
447 use base qw(Catalyst::Controller::REST);
451 ... do things before Deserializing ...
452 $self->NEXT::begin($c);
453 ... do things after Deserializing ...
458 ... do things before Serializing ...
459 $self->NEXT::end($c);
460 ... do things after Serializing ...
465 =head1 A MILD WARNING
467 I have code in production using L<Catalyst::Controller::REST>. That said,
468 it is still under development, and it's possible that things may change
469 between releases. I promise to not break things unneccesarily. :)
473 L<Catalyst::Action::REST>, L<Catalyst::Action::Serialize>,
474 L<Catalyst::Action::Deserialize>
476 For help with REST in general:
478 The HTTP 1.1 Spec is required reading. http://www.w3.org/Protocols/rfc2616/rfc2616.txt
480 Wikipedia! http://en.wikipedia.org/wiki/Representational_State_Transfer
482 The REST Wiki: http://rest.blueoxen.net/cgi-bin/wiki.pl?FrontPage
486 Adam Jacob <adam@stalecoffee.org>, with lots of help from mst and jrockway
488 Marchex, Inc. paid me while I developed this module. (http://www.marchex.com)
492 J. Shirley <jshirley@cpan.org>
496 You may distribute this code under the same terms as Perl itself.