NAME

Catalyst::Controller::DBIC::API::REST - Provides a REST interface to DBIx::Class

VERSION

version 2.001001

DESCRIPTION

Provides a REST style API interface to the functionality described in Catalyst::Controller::DBIC::API.

By default provides the following endpoints:

  $base (accepts PUT and GET)
  $base/[identifier] (accepts POST and DELETE)

Where $base is the URI described by "setup", the chain root of the controller, and the request type will determine the Catalyst::Controller::DBIC::API method to forward.

PROTECTED_METHODS

setup

Chained: override PathPart: override CaptureArgs: 0

As described in "setup" in Catalyst::Controller::DBIC::API, this action is the chain root of the controller but has no pathpart or chain parent defined by default, so these must be defined in order for the controller to function. The neatest way is normally to define these using the controller's config.

  __PACKAGE__->config
    ( action => { setup => { PathPart => 'track', Chained => '/api/rest/rest_base' } }, 
        ...
  );

base

Chained: "setup" PathPart: none CaptureArgs: 0

Forwards to list level methods described in Catalyst::Controller::DBIC::API as follows:

DELETE: forwards to "object" in Catalyst::Controller::DBIC::API then "delete" in Catalyst::Controller::DBIC::API POST/PUT: forwards to "object" in Catalyst::Controller::DBIC::API then "update_or_create" in Catalyst::Controller::DBIC::API GET: forwards to "list" in Catalyst::Controller::DBIC::API

AUTHORS

  Nicholas Perez <nperez@cpan.org>
  Luke Saunders <luke.saunders@gmail.com>
  Alexander Hartmaier <abraxxa@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2010 by Luke Saunders, Nicholas Perez, et al..

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.