Commit | Line | Data |
256c894f |
1 | package Catalyst::Controller::REST; |
930013e6 |
2 | use Moose; |
3 | use namespace::autoclean; |
256c894f |
4 | |
cf712a31 |
5 | our $VERSION = '1.08'; |
a66af307 |
6 | $VERSION = eval $VERSION; |
832e768d |
7 | |
398c5a1b |
8 | =head1 NAME |
9 | |
db8bb647 |
10 | Catalyst::Controller::REST - A RESTful controller |
398c5a1b |
11 | |
12 | =head1 SYNOPSIS |
13 | |
14 | package Foo::Controller::Bar; |
5cb5f6bb |
15 | use Moose; |
16 | use namespace::autoclean; |
259c53c7 |
17 | |
5cb5f6bb |
18 | BEGIN { extends 'Catalyst::Controller::REST' } |
398c5a1b |
19 | |
20 | sub thing : Local : ActionClass('REST') { } |
21 | |
22 | # Answer GET requests to "thing" |
23 | sub thing_GET { |
24 | my ( $self, $c ) = @_; |
db8bb647 |
25 | |
398c5a1b |
26 | # Return a 200 OK, with the data in entity |
db8bb647 |
27 | # serialized in the body |
398c5a1b |
28 | $self->status_ok( |
db8bb647 |
29 | $c, |
398c5a1b |
30 | entity => { |
31 | some => 'data', |
32 | foo => 'is real bar-y', |
33 | }, |
34 | ); |
35 | } |
36 | |
37 | # Answer PUT requests to "thing" |
db8bb647 |
38 | sub thing_PUT { |
ace04991 |
39 | my ( $self, $c ) = @_; |
40 | |
fcf45ed9 |
41 | $radiohead = $c->req->data->{radiohead}; |
259c53c7 |
42 | |
10bcd217 |
43 | $self->status_created( |
44 | $c, |
259c53c7 |
45 | location => $c->req->uri, |
10bcd217 |
46 | entity => { |
47 | radiohead => $radiohead, |
48 | } |
49 | ); |
259c53c7 |
50 | } |
398c5a1b |
51 | |
52 | =head1 DESCRIPTION |
53 | |
54 | Catalyst::Controller::REST implements a mechanism for building |
55 | RESTful services in Catalyst. It does this by extending the |
db8bb647 |
56 | normal Catalyst dispatch mechanism to allow for different |
57 | subroutines to be called based on the HTTP Method requested, |
398c5a1b |
58 | while also transparently handling all the serialization/deserialization for |
59 | you. |
60 | |
61 | This is probably best served by an example. In the above |
62 | controller, we have declared a Local Catalyst action on |
db8bb647 |
63 | "sub thing", and have used the ActionClass('REST'). |
398c5a1b |
64 | |
65 | Below, we have declared "thing_GET" and "thing_PUT". Any |
db8bb647 |
66 | GET requests to thing will be dispatched to "thing_GET", |
67 | while any PUT requests will be dispatched to "thing_PUT". |
398c5a1b |
68 | |
e601adda |
69 | Any unimplemented HTTP methods will be met with a "405 Method Not Allowed" |
70 | response, automatically containing the proper list of available methods. You |
71 | can override this behavior through implementing a custom |
db8bb647 |
72 | C<thing_not_implemented> method. |
e601adda |
73 | |
74 | If you do not provide an OPTIONS handler, we will respond to any OPTIONS |
75 | requests with a "200 OK", populating the Allowed header automatically. |
76 | |
77 | Any data included in C<< $c->stash->{'rest'} >> will be serialized for you. |
78 | The serialization format will be selected based on the content-type |
79 | of the incoming request. It is probably easier to use the L<STATUS HELPERS>, |
80 | which are described below. |
398c5a1b |
81 | |
10bcd217 |
82 | "The HTTP POST, PUT, and OPTIONS methods will all automatically |
83 | L<deserialize|Catalyst::Action::Deserialize> the contents of |
259c53c7 |
84 | C<< $c->request->body >> into the C<< $c->request->data >> hashref", based on |
10bcd217 |
85 | the request's C<Content-type> header. A list of understood serialization |
86 | formats is L<below|/AVAILABLE SERIALIZERS>. |
398c5a1b |
87 | |
e601adda |
88 | If we do not have (or cannot run) a serializer for a given content-type, a 415 |
db8bb647 |
89 | "Unsupported Media Type" error is generated. |
398c5a1b |
90 | |
91 | To make your Controller RESTful, simply have it |
92 | |
5cb5f6bb |
93 | BEGIN { extends 'Catalyst::Controller::REST' } |
398c5a1b |
94 | |
9cd203c9 |
95 | =head1 CONFIGURATION |
96 | |
97 | See L<Catalyst::Action::Serialize/CONFIGURATION>. Note that the C<serialize> |
98 | key has been deprecated. |
99 | |
398c5a1b |
100 | =head1 SERIALIZATION |
101 | |
102 | Catalyst::Controller::REST will automatically serialize your |
e601adda |
103 | responses, and deserialize any POST, PUT or OPTIONS requests. It evaluates |
104 | which serializer to use by mapping a content-type to a Serialization module. |
db8bb647 |
105 | We select the content-type based on: |
e601adda |
106 | |
5cb5f6bb |
107 | =over |
e601adda |
108 | |
109 | =item B<The Content-Type Header> |
110 | |
111 | If the incoming HTTP Request had a Content-Type header set, we will use it. |
112 | |
113 | =item B<The content-type Query Parameter> |
114 | |
115 | If this is a GET request, you can supply a content-type query parameter. |
116 | |
117 | =item B<Evaluating the Accept Header> |
118 | |
119 | Finally, if the client provided an Accept header, we will evaluate |
db8bb647 |
120 | it and use the best-ranked choice. |
e601adda |
121 | |
122 | =back |
123 | |
124 | =head1 AVAILABLE SERIALIZERS |
125 | |
126 | A given serialization mechanism is only available if you have the underlying |
127 | modules installed. For example, you can't use XML::Simple if it's not already |
db8bb647 |
128 | installed. |
e601adda |
129 | |
95318468 |
130 | In addition, each serializer has its quirks in terms of what sorts of data |
e601adda |
131 | structures it will properly handle. L<Catalyst::Controller::REST> makes |
db8bb647 |
132 | no attempt to save you from yourself in this regard. :) |
e601adda |
133 | |
134 | =over 2 |
135 | |
95318468 |
136 | =item * C<text/x-yaml> => C<YAML::Syck> |
e601adda |
137 | |
138 | Returns YAML generated by L<YAML::Syck>. |
139 | |
95318468 |
140 | =item * C<text/html> => C<YAML::HTML> |
e601adda |
141 | |
142 | This uses L<YAML::Syck> and L<URI::Find> to generate YAML with all URLs turned |
26b59bcb |
143 | to hyperlinks. Only usable for Serialization. |
e601adda |
144 | |
95318468 |
145 | =item * C<application/json> => C<JSON> |
e601adda |
146 | |
db8bb647 |
147 | Uses L<JSON> to generate JSON output. It is strongly advised to also have |
e540a1fa |
148 | L<JSON::XS> installed. The C<text/x-json> content type is supported but is |
149 | deprecated and you will receive warnings in your log. |
e601adda |
150 | |
838f49dc |
151 | You can also add a hash in your controller config to pass options to the json object. |
152 | For instance, to relax permissions when deserializing input, add: |
153 | __PACKAGE__->config( |
154 | json_options => { relaxed => 1 } |
155 | ) |
156 | |
d0d292d4 |
157 | =item * C<text/javascript> => C<JSONP> |
158 | |
159 | If a callback=? parameter is passed, this returns javascript in the form of: $callback($serializedJSON); |
160 | |
92d78e8f |
161 | Note - this is disabled by default as it can be a security risk if you are unaware. |
162 | |
163 | The usual MIME types for this serialization format are: 'text/javascript', 'application/x-javascript', |
164 | 'application/javascript'. |
165 | |
95318468 |
166 | =item * C<text/x-data-dumper> => C<Data::Serializer> |
e601adda |
167 | |
168 | Uses the L<Data::Serializer> module to generate L<Data::Dumper> output. |
169 | |
95318468 |
170 | =item * C<text/x-data-denter> => C<Data::Serializer> |
e601adda |
171 | |
172 | Uses the L<Data::Serializer> module to generate L<Data::Denter> output. |
173 | |
95318468 |
174 | =item * C<text/x-data-taxi> => C<Data::Serializer> |
e601adda |
175 | |
176 | Uses the L<Data::Serializer> module to generate L<Data::Taxi> output. |
177 | |
95318468 |
178 | =item * C<text/x-config-general> => C<Data::Serializer> |
e601adda |
179 | |
180 | Uses the L<Data::Serializer> module to generate L<Config::General> output. |
181 | |
95318468 |
182 | =item * C<text/x-php-serialization> => C<Data::Serializer> |
e601adda |
183 | |
184 | Uses the L<Data::Serializer> module to generate L<PHP::Serialization> output. |
185 | |
95318468 |
186 | =item * C<text/xml> => C<XML::Simple> |
e601adda |
187 | |
188 | Uses L<XML::Simple> to generate XML output. This is probably not suitable |
189 | for any real heavy XML work. Due to L<XML::Simple>s requirement that the data |
190 | you serialize be a HASHREF, we transform outgoing data to be in the form of: |
191 | |
192 | { data => $yourdata } |
193 | |
95318468 |
194 | =item * L<View> |
9a76221e |
195 | |
db8bb647 |
196 | Uses a regular Catalyst view. For example, if you wanted to have your |
3d8a0645 |
197 | C<text/html> and C<text/xml> views rendered by TT, set: |
198 | |
199 | __PACKAGE__->config( |
200 | map => { |
201 | 'text/html' => [ 'View', 'TT' ], |
202 | 'text/xml' => [ 'View', 'XML' ], |
203 | } |
5cb5f6bb |
204 | ); |
3d8a0645 |
205 | |
206 | Your views should have a C<process> method like this: |
207 | |
208 | sub process { |
209 | my ( $self, $c, $stash_key ) = @_; |
5cb5f6bb |
210 | |
3d8a0645 |
211 | my $output; |
212 | eval { |
213 | $output = $self->serialize( $c->stash->{$stash_key} ); |
214 | }; |
215 | return $@ if $@; |
5cb5f6bb |
216 | |
3d8a0645 |
217 | $c->response->body( $output ); |
218 | return 1; # important |
219 | } |
259c53c7 |
220 | |
3d8a0645 |
221 | sub serialize { |
222 | my ( $self, $data ) = @_; |
5cb5f6bb |
223 | |
3d8a0645 |
224 | my $serialized = ... process $data here ... |
5cb5f6bb |
225 | |
3d8a0645 |
226 | return $serialized; |
227 | } |
9a76221e |
228 | |
178f8470 |
229 | =item * Callback |
230 | |
231 | For infinite flexibility, you can provide a callback for the |
232 | deserialization/serialization steps. |
233 | |
234 | __PACKAGE__->config( |
235 | map => { |
236 | 'text/xml' => [ 'Callback', { deserialize => \&parse_xml, serialize => \&render_xml } ], |
237 | } |
238 | ); |
239 | |
240 | The C<deserialize> callback is passed a string that is the body of the |
241 | request and is expected to return a scalar value that results from |
242 | the deserialization. The C<serialize> callback is passed the data |
243 | structure that needs to be serialized and must return a string suitable |
244 | for returning in the HTTP response. In addition to receiving the scalar |
245 | to act on, both callbacks are passed the controller object and the context |
246 | (i.e. C<$c>) as the second and third arguments. |
247 | |
e601adda |
248 | =back |
249 | |
259c53c7 |
250 | By default, L<Catalyst::Controller::REST> will return a |
95318468 |
251 | C<415 Unsupported Media Type> response if an attempt to use an unsupported |
252 | content-type is made. You can ensure that something is always returned by |
253 | setting the C<default> config option: |
398c5a1b |
254 | |
5cb5f6bb |
255 | __PACKAGE__->config(default => 'text/x-yaml'); |
398c5a1b |
256 | |
95318468 |
257 | would make it always fall back to the serializer plugin defined for |
258 | C<text/x-yaml>. |
398c5a1b |
259 | |
e601adda |
260 | =head1 CUSTOM SERIALIZERS |
261 | |
95318468 |
262 | Implementing new Serialization formats is easy! Contributions |
259c53c7 |
263 | are most welcome! If you would like to implement a custom serializer, |
95318468 |
264 | you should create two new modules in the L<Catalyst::Action::Serialize> |
265 | and L<Catalyst::Action::Deserialize> namespace. Then assign your new |
266 | class to the content-type's you want, and you're done. |
267 | |
259c53c7 |
268 | See L<Catalyst::Action::Serialize> and L<Catalyst::Action::Deserialize> |
95318468 |
269 | for more information. |
e601adda |
270 | |
398c5a1b |
271 | =head1 STATUS HELPERS |
272 | |
e601adda |
273 | Since so much of REST is in using HTTP, we provide these Status Helpers. |
274 | Using them will ensure that you are responding with the proper codes, |
275 | headers, and entities. |
276 | |
398c5a1b |
277 | These helpers try and conform to the HTTP 1.1 Specification. You can |
db8bb647 |
278 | refer to it at: L<http://www.w3.org/Protocols/rfc2616/rfc2616.txt>. |
398c5a1b |
279 | These routines are all implemented as regular subroutines, and as |
280 | such require you pass the current context ($c) as the first argument. |
281 | |
5cb5f6bb |
282 | =over |
398c5a1b |
283 | |
284 | =cut |
285 | |
930013e6 |
286 | BEGIN { extends 'Catalyst::Controller' } |
d4611771 |
287 | use Params::Validate qw(SCALAR OBJECT); |
256c894f |
288 | |
289 | __PACKAGE__->mk_accessors(qw(serialize)); |
290 | |
291 | __PACKAGE__->config( |
e540a1fa |
292 | 'stash_key' => 'rest', |
293 | 'map' => { |
294 | 'text/html' => 'YAML::HTML', |
295 | 'text/xml' => 'XML::Simple', |
296 | 'text/x-yaml' => 'YAML', |
297 | 'application/json' => 'JSON', |
298 | 'text/x-json' => 'JSON', |
e540a1fa |
299 | }, |
256c894f |
300 | ); |
301 | |
e540a1fa |
302 | sub begin : ActionClass('Deserialize') { } |
5511d1ff |
303 | |
0ba73721 |
304 | sub end : ActionClass('Serialize') { } |
305 | |
398c5a1b |
306 | =item status_ok |
307 | |
308 | Returns a "200 OK" response. Takes an "entity" to serialize. |
309 | |
310 | Example: |
311 | |
312 | $self->status_ok( |
db8bb647 |
313 | $c, |
398c5a1b |
314 | entity => { |
315 | radiohead => "Is a good band!", |
316 | } |
317 | ); |
318 | |
319 | =cut |
320 | |
321 | sub status_ok { |
322 | my $self = shift; |
e601adda |
323 | my $c = shift; |
d4611771 |
324 | my %p = Params::Validate::validate( @_, { entity => 1, }, ); |
398c5a1b |
325 | |
326 | $c->response->status(200); |
e601adda |
327 | $self->_set_entity( $c, $p{'entity'} ); |
398c5a1b |
328 | return 1; |
329 | } |
330 | |
331 | =item status_created |
332 | |
333 | Returns a "201 CREATED" response. Takes an "entity" to serialize, |
334 | and a "location" where the created object can be found. |
335 | |
336 | Example: |
337 | |
338 | $self->status_created( |
db8bb647 |
339 | $c, |
259c53c7 |
340 | location => $c->req->uri, |
398c5a1b |
341 | entity => { |
342 | radiohead => "Is a good band!", |
343 | } |
344 | ); |
345 | |
346 | In the above example, we use the requested URI as our location. |
347 | This is probably what you want for most PUT requests. |
348 | |
349 | =cut |
bb4130f6 |
350 | |
5511d1ff |
351 | sub status_created { |
352 | my $self = shift; |
e601adda |
353 | my $c = shift; |
d4611771 |
354 | my %p = Params::Validate::validate( |
e601adda |
355 | @_, |
5511d1ff |
356 | { |
e601adda |
357 | location => { type => SCALAR | OBJECT }, |
358 | entity => { optional => 1 }, |
5511d1ff |
359 | }, |
360 | ); |
256c894f |
361 | |
5511d1ff |
362 | $c->response->status(201); |
259c53c7 |
363 | $c->response->header( 'Location' => $p{location} ); |
e601adda |
364 | $self->_set_entity( $c, $p{'entity'} ); |
bb4130f6 |
365 | return 1; |
366 | } |
367 | |
398c5a1b |
368 | =item status_accepted |
369 | |
370 | Returns a "202 ACCEPTED" response. Takes an "entity" to serialize. |
259c53c7 |
371 | Also takes optional "location" for queue type scenarios. |
398c5a1b |
372 | |
373 | Example: |
374 | |
375 | $self->status_accepted( |
db8bb647 |
376 | $c, |
259c53c7 |
377 | location => $c->req->uri, |
398c5a1b |
378 | entity => { |
379 | status => "queued", |
380 | } |
381 | ); |
382 | |
383 | =cut |
e601adda |
384 | |
398c5a1b |
385 | sub status_accepted { |
bb4130f6 |
386 | my $self = shift; |
e601adda |
387 | my $c = shift; |
259c53c7 |
388 | my %p = Params::Validate::validate( |
389 | @_, |
390 | { |
391 | location => { type => SCALAR | OBJECT, optional => 1 }, |
392 | entity => 1, |
393 | }, |
394 | ); |
bb4130f6 |
395 | |
398c5a1b |
396 | $c->response->status(202); |
259c53c7 |
397 | $c->response->header( 'Location' => $p{location} ) if exists $p{location}; |
e601adda |
398 | $self->_set_entity( $c, $p{'entity'} ); |
bb4130f6 |
399 | return 1; |
400 | } |
401 | |
bbf0feae |
402 | =item status_no_content |
403 | |
404 | Returns a "204 NO CONTENT" response. |
405 | |
406 | =cut |
407 | |
408 | sub status_no_content { |
409 | my $self = shift; |
410 | my $c = shift; |
411 | $c->response->status(204); |
412 | $self->_set_entity( $c, undef ); |
042656b6 |
413 | return 1; |
bbf0feae |
414 | } |
415 | |
bdff70a9 |
416 | =item status_multiple_choices |
417 | |
418 | Returns a "300 MULTIPLE CHOICES" response. Takes an "entity" to serialize, which should |
419 | provide list of possible locations. Also takes optional "location" for preferred choice. |
420 | |
421 | =cut |
422 | |
423 | sub status_multiple_choices { |
424 | my $self = shift; |
425 | my $c = shift; |
426 | my %p = Params::Validate::validate( |
427 | @_, |
428 | { |
429 | entity => 1, |
430 | location => { type => SCALAR | OBJECT, optional => 1 }, |
431 | }, |
432 | ); |
433 | |
bdff70a9 |
434 | $c->response->status(300); |
259c53c7 |
435 | $c->response->header( 'Location' => $p{location} ) if exists $p{'location'}; |
bdff70a9 |
436 | $self->_set_entity( $c, $p{'entity'} ); |
437 | return 1; |
438 | } |
439 | |
e52456a4 |
440 | =item status_found |
441 | |
442 | Returns a "302 FOUND" response. Takes an "entity" to serialize. |
259c53c7 |
443 | Also takes optional "location". |
e52456a4 |
444 | |
445 | =cut |
446 | |
447 | sub status_found { |
448 | my $self = shift; |
449 | my $c = shift; |
450 | my %p = Params::Validate::validate( |
451 | @_, |
452 | { |
453 | entity => 1, |
454 | location => { type => SCALAR | OBJECT, optional => 1 }, |
455 | }, |
456 | ); |
457 | |
e52456a4 |
458 | $c->response->status(302); |
259c53c7 |
459 | $c->response->header( 'Location' => $p{location} ) if exists $p{'location'}; |
e52456a4 |
460 | $self->_set_entity( $c, $p{'entity'} ); |
461 | return 1; |
462 | } |
463 | |
398c5a1b |
464 | =item status_bad_request |
465 | |
466 | Returns a "400 BAD REQUEST" response. Takes a "message" argument |
467 | as a scalar, which will become the value of "error" in the serialized |
468 | response. |
469 | |
470 | Example: |
471 | |
472 | $self->status_bad_request( |
db8bb647 |
473 | $c, |
33e5de96 |
474 | message => "Cannot do what you have asked!", |
398c5a1b |
475 | ); |
476 | |
477 | =cut |
e601adda |
478 | |
cc186a5b |
479 | sub status_bad_request { |
480 | my $self = shift; |
e601adda |
481 | my $c = shift; |
d4611771 |
482 | my %p = Params::Validate::validate( @_, { message => { type => SCALAR }, }, ); |
cc186a5b |
483 | |
484 | $c->response->status(400); |
faf5c20b |
485 | $c->log->debug( "Status Bad Request: " . $p{'message'} ) if $c->debug; |
e601adda |
486 | $self->_set_entity( $c, { error => $p{'message'} } ); |
cc186a5b |
487 | return 1; |
488 | } |
489 | |
550807bc |
490 | =item status_forbidden |
491 | |
492 | Returns a "403 FORBIDDEN" response. Takes a "message" argument |
493 | as a scalar, which will become the value of "error" in the serialized |
494 | response. |
495 | |
496 | Example: |
497 | |
498 | $self->status_forbidden( |
499 | $c, |
500 | message => "access denied", |
501 | ); |
502 | |
503 | =cut |
504 | |
505 | sub status_forbidden { |
506 | my $self = shift; |
507 | my $c = shift; |
508 | my %p = Params::Validate::validate( @_, { message => { type => SCALAR }, }, ); |
509 | |
510 | $c->response->status(403); |
511 | $c->log->debug( "Status Forbidden: " . $p{'message'} ) if $c->debug; |
512 | $self->_set_entity( $c, { error => $p{'message'} } ); |
513 | return 1; |
514 | } |
515 | |
398c5a1b |
516 | =item status_not_found |
517 | |
518 | Returns a "404 NOT FOUND" response. Takes a "message" argument |
519 | as a scalar, which will become the value of "error" in the serialized |
520 | response. |
521 | |
522 | Example: |
523 | |
524 | $self->status_not_found( |
db8bb647 |
525 | $c, |
33e5de96 |
526 | message => "Cannot find what you were looking for!", |
398c5a1b |
527 | ); |
528 | |
529 | =cut |
e601adda |
530 | |
bb4130f6 |
531 | sub status_not_found { |
532 | my $self = shift; |
e601adda |
533 | my $c = shift; |
d4611771 |
534 | my %p = Params::Validate::validate( @_, { message => { type => SCALAR }, }, ); |
bb4130f6 |
535 | |
536 | $c->response->status(404); |
faf5c20b |
537 | $c->log->debug( "Status Not Found: " . $p{'message'} ) if $c->debug; |
e601adda |
538 | $self->_set_entity( $c, { error => $p{'message'} } ); |
bb4130f6 |
539 | return 1; |
540 | } |
541 | |
bbf0feae |
542 | =item gone |
543 | |
544 | Returns a "41O GONE" response. Takes a "message" argument as a scalar, |
545 | which will become the value of "error" in the serialized response. |
546 | |
547 | Example: |
548 | |
549 | $self->status_gone( |
550 | $c, |
551 | message => "The document have been deleted by foo", |
552 | ); |
553 | |
554 | =cut |
555 | |
556 | sub status_gone { |
557 | my $self = shift; |
558 | my $c = shift; |
559 | my %p = Params::Validate::validate( @_, { message => { type => SCALAR }, }, ); |
560 | |
561 | $c->response->status(410); |
562 | $c->log->debug( "Status Gone " . $p{'message'} ) if $c->debug; |
563 | $self->_set_entity( $c, { error => $p{'message'} } ); |
564 | return 1; |
565 | } |
566 | |
bb4130f6 |
567 | sub _set_entity { |
e601adda |
568 | my $self = shift; |
569 | my $c = shift; |
bb4130f6 |
570 | my $entity = shift; |
e601adda |
571 | if ( defined($entity) ) { |
faf5c20b |
572 | $c->stash->{ $self->{'stash_key'} } = $entity; |
5511d1ff |
573 | } |
574 | return 1; |
eccb2137 |
575 | } |
256c894f |
576 | |
398c5a1b |
577 | =back |
578 | |
579 | =head1 MANUAL RESPONSES |
580 | |
581 | If you want to construct your responses yourself, all you need to |
582 | do is put the object you want serialized in $c->stash->{'rest'}. |
583 | |
e601adda |
584 | =head1 IMPLEMENTATION DETAILS |
585 | |
586 | This Controller ties together L<Catalyst::Action::REST>, |
587 | L<Catalyst::Action::Serialize> and L<Catalyst::Action::Deserialize>. It should be suitable for most applications. You should be aware that it: |
588 | |
589 | =over 4 |
590 | |
591 | =item Configures the Serialization Actions |
592 | |
593 | This class provides a default configuration for Serialization. It is currently: |
594 | |
595 | __PACKAGE__->config( |
95318468 |
596 | 'stash_key' => 'rest', |
597 | 'map' => { |
598 | 'text/html' => 'YAML::HTML', |
599 | 'text/xml' => 'XML::Simple', |
600 | 'text/x-yaml' => 'YAML', |
601 | 'application/json' => 'JSON', |
602 | 'text/x-json' => 'JSON', |
603 | 'text/x-data-dumper' => [ 'Data::Serializer', 'Data::Dumper' ], |
604 | 'text/x-data-denter' => [ 'Data::Serializer', 'Data::Denter' ], |
605 | 'text/x-data-taxi' => [ 'Data::Serializer', 'Data::Taxi' ], |
606 | 'application/x-storable' => [ 'Data::Serializer', 'Storable' ], |
607 | 'application/x-freezethaw' => [ 'Data::Serializer', 'FreezeThaw' ], |
608 | 'text/x-config-general' => [ 'Data::Serializer', 'Config::General' ], |
609 | 'text/x-php-serialization' => [ 'Data::Serializer', 'PHP::Serialization' ], |
610 | }, |
e601adda |
611 | ); |
612 | |
613 | You can read the full set of options for this configuration block in |
614 | L<Catalyst::Action::Serialize>. |
615 | |
616 | =item Sets a C<begin> and C<end> method for you |
617 | |
618 | The C<begin> method uses L<Catalyst::Action::Deserialize>. The C<end> |
619 | method uses L<Catalyst::Action::Serialize>. If you want to override |
620 | either behavior, simply implement your own C<begin> and C<end> actions |
355d4385 |
621 | and forward to another action with the Serialize and/or Deserialize |
622 | action classes: |
e601adda |
623 | |
10bcd217 |
624 | package Foo::Controller::Monkey; |
625 | use Moose; |
626 | use namespace::autoclean; |
355d4385 |
627 | |
10bcd217 |
628 | BEGIN { extends 'Catalyst::Controller::REST' } |
e601adda |
629 | |
355d4385 |
630 | sub begin : Private { |
e601adda |
631 | my ($self, $c) = @_; |
db8bb647 |
632 | ... do things before Deserializing ... |
355d4385 |
633 | $c->forward('deserialize'); |
e601adda |
634 | ... do things after Deserializing ... |
db8bb647 |
635 | } |
e601adda |
636 | |
355d4385 |
637 | sub deserialize : ActionClass('Deserialize') {} |
638 | |
e601adda |
639 | sub end :Private { |
640 | my ($self, $c) = @_; |
db8bb647 |
641 | ... do things before Serializing ... |
355d4385 |
642 | $c->forward('serialize'); |
e601adda |
643 | ... do things after Serializing ... |
644 | } |
645 | |
355d4385 |
646 | sub serialize : ActionClass('Serialize') {} |
647 | |
8bf1f20e |
648 | If you need to deserialize multipart requests (i.e. REST data in |
649 | one part and file uploads in others) you can do so by using the |
650 | L<Catalyst::Action::DeserializeMultiPart> action class. |
651 | |
e540a1fa |
652 | =back |
653 | |
e601adda |
654 | =head1 A MILD WARNING |
655 | |
656 | I have code in production using L<Catalyst::Controller::REST>. That said, |
657 | it is still under development, and it's possible that things may change |
d6ece98c |
658 | between releases. I promise to not break things unnecessarily. :) |
e601adda |
659 | |
398c5a1b |
660 | =head1 SEE ALSO |
661 | |
662 | L<Catalyst::Action::REST>, L<Catalyst::Action::Serialize>, |
663 | L<Catalyst::Action::Deserialize> |
664 | |
665 | For help with REST in general: |
666 | |
667 | The HTTP 1.1 Spec is required reading. http://www.w3.org/Protocols/rfc2616/rfc2616.txt |
668 | |
669 | Wikipedia! http://en.wikipedia.org/wiki/Representational_State_Transfer |
670 | |
671 | The REST Wiki: http://rest.blueoxen.net/cgi-bin/wiki.pl?FrontPage |
672 | |
5cb5f6bb |
673 | =head1 AUTHORS |
e540a1fa |
674 | |
5cb5f6bb |
675 | See L<Catalyst::Action::REST> for authors. |
e540a1fa |
676 | |
398c5a1b |
677 | =head1 LICENSE |
678 | |
679 | You may distribute this code under the same terms as Perl itself. |
680 | |
681 | =cut |
682 | |
24748286 |
683 | __PACKAGE__->meta->make_immutable; |
684 | |
256c894f |
685 | 1; |