1 package Catalyst::Action::REST;
4 use namespace::autoclean;
6 extends 'Catalyst::Action';
8 use Catalyst::Request::REST;
9 use Catalyst::Controller::REST;
11 BEGIN { require 5.008001; }
13 our $VERSION = '0.87';
14 $VERSION = eval $VERSION;
19 Catalyst::Request::REST->_insert_self_into( $config->{class} );
20 return $class->next::method($config, @_);
25 Catalyst::Action::REST - Automated REST Method Dispatching
29 sub foo :Local :ActionClass('REST') {
30 ... do setup for HTTP method specific handlers ...
34 ... do something for GET requests ...
37 # alternatively use an Action
38 sub foo_PUT : Action {
39 ... do something for PUT requests ...
44 This Action handles doing automatic method dispatching for REST requests. It
45 takes a normal Catalyst action, and changes the dispatch to append an
46 underscore and method name. First it will try dispatching to an action with
47 the generated name, and failing that it will try to dispatch to a regular
50 For example, in the synopsis above, calling GET on "/foo" would result in
51 the foo_GET method being dispatched.
53 If a method is requested that is not implemented, this action will
54 return a status 405 (Method Not Found). It will populate the "Allow" header
55 with the list of implemented request methods. You can override this behavior
56 by implementing a custom 405 handler like so:
58 sub foo_not_implemented {
59 ... handle not implemented methods ...
62 If you do not provide an _OPTIONS subroutine, we will automatically respond
63 with a 200 OK. The "Allow" header will be populated with the list of
64 implemented request methods.
66 It is likely that you really want to look at L<Catalyst::Controller::REST>,
67 which brings this class together with automatic Serialization of requests
70 When you use this module, it adds the L<Catalyst::TraitFor::Request::REST>
71 role to your request class.
79 This method overrides the default dispatch mechanism to the re-dispatching
80 mechanism described above.
88 my $controller = $c->component( $self->class );
89 my $rest_method = $self->name . "_" . uc( $c->request->method );
93 # Common case, for foo_GET etc
94 if ( $code = $controller->action_for($rest_method) ) {
95 $c->execute( $self->class, $self, @{ $c->req->args } ); # Execute normal 'foo' action.
96 return $c->forward( $code, $c->req->args ); # Forward to foo_GET if it's an action
98 elsif ($code = $controller->can($rest_method)) {
99 # Exceute normal action
100 $c->execute( $self->class, $self, @{ $c->req->args } );
101 $name = $rest_method; # Stash name and code to run 'foo_GET' like an action below.
104 # Generic handling for foo_OPTIONS
105 if (!$code && $c->request->method eq "OPTIONS") {
106 $name = $rest_method;
107 $code = sub { $self->_return_options($self->name, @_) };
110 # Otherwise, not implemented.
112 $name = $self->name . "_not_implemented";
113 $code = $controller->can($name) # User method
114 # Generic not implemented
115 || sub { $self->_return_not_implemented($self->name, @_) };
118 # localise stuff so we can dispatch the action 'as normal, but get
119 # different stats shown, and different code run.
120 local $self->{code} = $code;
121 local $self->{reverse} = $name;
123 $c->execute( $self->class, $self, @{ $c->req->args } );
126 sub _get_allowed_methods {
127 my ( $self, $controller, $c, $name ) = @_;
128 my $class = ref($controller) ? ref($controller) : $controller;
129 my $methods = Class::Inspector->methods($class);
130 return map { /^$name\_(.+)$/ } @$methods;
133 sub _return_options {
134 my ( $self, $method_name, $controller, $c) = @_;
135 my @allowed = $self->_get_allowed_methods($controller, $c, $method_name);
136 $c->response->content_type('text/plain');
137 $c->response->status(200);
138 $c->response->header( 'Allow' => \@allowed );
141 sub _return_not_implemented {
142 my ( $self, $method_name, $controller, $c ) = @_;
144 my @allowed = $self->_get_allowed_methods($controller, $c, $method_name);
145 $c->response->content_type('text/plain');
146 $c->response->status(405);
147 $c->response->header( 'Allow' => \@allowed );
148 $c->response->body( "Method "
149 . $c->request->method
150 . " not implemented for "
151 . $c->uri_for( $method_name ) );
160 You likely want to look at L<Catalyst::Controller::REST>, which implements a
161 sensible set of defaults for a controller doing REST.
163 This class automatically adds the L<Catalyst::TraitFor::Request::REST> role to
164 your request class. If you're writing a webapp which provides RESTful
165 responses and still needs to accommodate web browsers, you may prefer to use
166 L<Catalyst::TraitFor::Request::REST::ForBrowsers> instead.
168 L<Catalyst::Action::Serialize>, L<Catalyst::Action::Deserialize>
170 =head1 TROUBLESHOOTING
174 =item Q: I'm getting a "415 Unsupported Media Type" error. What gives?!
176 A: Most likely, you haven't set Content-type equal to "application/json", or
177 one of the accepted return formats. You can do this by setting it in your query
178 accepted return formats. You can do this by setting it in your query string
179 thusly: C<< ?content-type=application%2Fjson (where %2F == / uri escaped). >>
181 B<NOTE> Apache will refuse %2F unless configured otherwise.
182 Make sure C<AllowEncodedSlashes On> is in your httpd.conf file in order
183 for this to run smoothly.
189 Adam Jacob E<lt>adam@stalecoffee.orgE<gt>, with lots of help from mst and jrockway
191 Marchex, Inc. paid me while I developed this module. (L<http://www.marchex.com>)
195 Tomas Doran (t0m) E<lt>bobtfish@bobtfish.netE<gt>
201 Daisuke Maki E<lt>daisuke@endeworks.jpE<gt>
205 Dave Rolsky E<lt>autarch@urth.orgE<gt>
209 Arthur Axel "fREW" Schmidt E<lt>frioux@gmail.comE<gt>
211 J. Shirley E<lt>jshirley@gmail.comE<gt>
215 Copyright the above named AUTHOR and CONTRIBUTORS
219 You may distribute this code under the same terms as Perl itself.