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.88';
14 $VERSION = eval $VERSION;
19 Catalyst::Request::REST->_insert_self_into( $config->{class} );
20 return $class->SUPER::BUILDARGS($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 # Execute 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
106 if ( $c->request->method eq "OPTIONS") {
107 $name = $rest_method;
108 $code = sub { $self->_return_options($self->name, @_) };
111 # 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, @_) };
119 # localise stuff so we can dispatch the action 'as normal, but get
120 # different stats shown, and different code run.
121 local $self->{code} = $code;
122 local $self->{reverse} = $name;
124 $c->execute( $self->class, $self, @{ $c->req->args } );
127 sub _get_allowed_methods {
128 my ( $self, $controller, $c, $name ) = @_;
129 my $class = ref($controller) ? ref($controller) : $controller;
130 my $methods = Class::Inspector->methods($class);
131 return map { /^$name\_(.+)$/ } @$methods;
134 sub _return_options {
135 my ( $self, $method_name, $controller, $c) = @_;
136 my @allowed = $self->_get_allowed_methods($controller, $c, $method_name);
137 $c->response->content_type('text/plain');
138 $c->response->status(200);
139 $c->response->header( 'Allow' => \@allowed );
142 sub _return_not_implemented {
143 my ( $self, $method_name, $controller, $c ) = @_;
145 my @allowed = $self->_get_allowed_methods($controller, $c, $method_name);
146 $c->response->content_type('text/plain');
147 $c->response->status(405);
148 $c->response->header( 'Allow' => \@allowed );
149 $c->response->body( "Method "
150 . $c->request->method
151 . " not implemented for "
152 . $c->uri_for( $method_name ) );
155 __PACKAGE__->meta->make_immutable;
163 You likely want to look at L<Catalyst::Controller::REST>, which implements a
164 sensible set of defaults for a controller doing REST.
166 This class automatically adds the L<Catalyst::TraitFor::Request::REST> role to
167 your request class. If you're writing a web application which provides RESTful
168 responses and still needs to accommodate web browsers, you may prefer to use
169 L<Catalyst::TraitFor::Request::REST::ForBrowsers> instead.
171 L<Catalyst::Action::Serialize>, L<Catalyst::Action::Deserialize>
173 =head1 TROUBLESHOOTING
177 =item Q: I'm getting a "415 Unsupported Media Type" error. What gives?!
179 A: Most likely, you haven't set Content-type equal to "application/json", or
180 one of the accepted return formats. You can do this by setting it in your query
181 accepted return formats. You can do this by setting it in your query string
182 thusly: C<< ?content-type=application%2Fjson (where %2F == / uri escaped). >>
184 B<NOTE> Apache will refuse %2F unless configured otherwise.
185 Make sure C<AllowEncodedSlashes On> is in your httpd.conf file in order
186 for this to run smoothly.
192 Adam Jacob E<lt>adam@stalecoffee.orgE<gt>, with lots of help from mst and jrockway
194 Marchex, Inc. paid me while I developed this module. (L<http://www.marchex.com>)
198 Tomas Doran (t0m) E<lt>bobtfish@bobtfish.netE<gt>
204 Daisuke Maki E<lt>daisuke@endeworks.jpE<gt>
208 Dave Rolsky E<lt>autarch@urth.orgE<gt>
212 Arthur Axel "fREW" Schmidt E<lt>frioux@gmail.comE<gt>
214 J. Shirley E<lt>jshirley@gmail.comE<gt>
218 Copyright the above named AUTHOR and CONTRIBUTORS
222 You may distribute this code under the same terms as Perl itself.