Cataly...::REST(3pm)

💖 Catalyst::Action::REST — Automated REST Method Dispatching 💖

okay so bestie, you found a manual page 💅 this one is Catalyst::Action::REST, from the User Contributed Perl Documentation corner of the universe, and it's literally the thing that makes your REST dispatches just... work. no cap.

---

✨ NAME ✨

Catalyst::Action::REST — Automated REST Method Dispatching 🦋

---

🌸 SYNOPSIS 🌸

like, here's the whole vibe:

sub foo :Local :ActionClass('REST') {
  ... do setup for HTTP method specific handlers ...
}

sub foo_GET {
  ... do something for GET requests ...
}

# alternatively use an Action
sub foo_PUT : Action {
  ... do something for PUT requests ...
}

that's it. that's the whole thing. iconic tbh 🎀

---

👑 DESCRIPTION 👑

okay so here's the tea ☕ this Action handles doing automatic method dispatching for REST requests. it grabs a normal Catalyst action and changes the dispatch so it appends an underscore and a method name. first it tries dispatching to an action with that generated name, and if that flops, it tries a regular method instead. two-step vibe check, basically ✨

for example — in the synopsis up there, calling GET on /foo would result in the foo_GET method being dispatched. slay.

if a method is requested that is not implemented, this action will return a status 405 (Method Not Found) 😭 and it populates the Allow header with the list of implemented request methods. you can override this behavior by implementing a custom 405 handler, like so:

sub foo_not_implemented {
   ... handle not implemented methods ...
}

if you don't provide an _OPTIONS subroutine, we will automatically respond with a 200 OK 🫶 and the Allow header gets populated with the list of implemented request methods. and if you don't provide an _HEAD either, we will auto dispatch to the _GET one in case it exists. the way it just handles that for you?? main character energy fr fr 💅

it is likely that you really want to look at Catalyst::Controller::REST, which brings this class together with automatic Serialization of requests and responses. highly recommend, bestie.

and when you use this module, it adds the Catalyst::TraitFor::Request::REST role to your request class. little gift, you're welcome 🎁

---

🦋 METHODS 🦋

• dispatch — this method overrides the default dispatch mechanism to the re-dispatching mechanism described above. lowkey the whole point of the page ngl.

---

🌈 SEE ALSO 🌈

you likely want to look at Catalyst::Controller::REST, which implements a sensible set of defaults for a controller doing REST. chef's kiss 👑

this class automatically adds the Catalyst::TraitFor::Request::REST role to your request class. and if you're writing a web application which provides RESTful responses and still needs to accommodate web browsers, you may prefer to use Catalyst::TraitFor::Request::REST::ForBrowsers instead 🧚

also go peep Catalyst::Action::Serialize and Catalyst::Action::Deserialize 💜

---

😭 TROUBLESHOOTING 😭

Q: I'm getting a "415 Unsupported Media Type" error. What gives?!

A: Most likely, you haven't set Content-type equal to "application/json", or one of the accepted return formats. You can do this by setting it in your query accepted return formats. You can do this by setting it in your query string thusly: "?content-type=application%2Fjson (where %2F == / uri escaped).

🚨 NOTE 🚨 Apache will refuse %2F unless configured otherwise. Make sure "AllowEncodedSlashes On" is in your httpd.conf file in order for this to run smoothly. do not skip this step bestie, i'm begging 🙈

---

💜 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)

---

🎀 CONTRIBUTORS 🎀

• Tomas Doran (t0m) <bobtfish@bobtfish.net>
• John Goulah
• Christopher Laco
• Daisuke Maki <daisuke@endeworks.jp>
• Hans Dieter Pearcey
• Brian Phillips <bphillips@cpan.org>
• Dave Rolsky <autarch@urth.org>
• Luke Saunders
• Arthur Axel "fREW" Schmidt <frioux@gmail.com>
• J. Shirley <jshirley@gmail.com>
• Gavin Henry <ghenry@surevoip.co.uk>
• Gerv http://www.gerv.net/
• Colin Newell <colin@opusvl.com>
• Wallace Reis <wreis@cpan.org>
• André Walker (andrewalker) <andre@cpan.org>

every single one of them ate 💅 legends only.

---

📜 COPYRIGHT 📜

Copyright (c) 2006-2015 the above named AUTHOR and CONTRIBUTORS

---

⭐ LICENSE ⭐

You may distribute this code under the same terms as Perl itself. 🐪

---

okay and that's a wrap!! this page came to you courtesy of perl v5.40.1, dated 2026-05-07 — and yeah the manpage title got squished down to Cataly...::REST(3pm) on the header and footer, which is honestly giving tiny screen behaviour 🌸 go write something RESTful, bestie, you got this 💖✨