[Catalyst] API Versioning for Web Services

Bill Moseley moseley at hank.org
Sun Jul 27 17:09:46 BST 2008

On Sat, Jul 26, 2008 at 06:00:39AM +0100, Matt S Trout wrote:
> sub widget :Local VersionedXMLRPC('widget.get') {
> sub widget_xmlrpc_v1 {
> have VersionedXMLRPC apply a custom a ction class that does ->can
> based dispatch, same way Catalyst::Action::REST does.

C::Action::REST uses "ActionClass('REST')" to specify the class for
the action.  And with a custom request class, has a custom dispatcher to
dispatch based on the request method.

Your example above does not use ActionClass.  Were you suggesting that
these XMLRPC actions have their own action class, and if so how would
the actions be setup then?

I would think the Catalyst approach would be something like this:

    sub widget : Local ActionClass('XMLRPC', 'widget.get' ) {

There's more than one approach, of course.

My current approach (w/o versioning) is to have a custom dispatcher
type (which I push onto $c->dispatcher->preload_dispatch_types).  I
also have a custom HTTP::Body type to parse the XMLRPC payload.  Once
the XMLRPC method name is known from the request the dispatcher
searches for the matching action.

But, I do like the approach of matching the action, and then using
$controller->can to try and find an appropriate version as you

By the way, my assumption is I would have the entire XMLRPC API
versioned.  I asked about this on the XMLRPC list and it was
recommended that instead I version individual methods.  That is, have
separate method names that include a version:


which would make the Catalyst part very simple, but I'm not sure I
like that idea of each method having a version in the method name.

Bill Moseley
moseley at hank.org
Sent from my iMutt

More information about the Catalyst mailing list