NAME

Catalyst::Controller::DBIC::API::RPC

DESCRIPTION

Provides an RPC API interface to the functionality described in Catalyst::Controller::DBIC::API.

By default provides the following endpoints:

  $base/create
  $base/list
  $base/id/[identifier]/delete
  $base/id/[identifier]/update

Where $base is the URI described by "setup", the chain root of the controller.

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/rpc/rpc_base' } }, 
        ...
  );

object

Chained: "setup" PathPart: object CaptureArgs: 1

Provides an chain point to the functionality described in "object" in Catalyst::Controller::DBIC::API. All object level endpoints should use this as their chain root.

create

Chained: "setup" PathPart: create CaptureArgs: 0

Provides an endpoint to the functionality described in "create" in Catalyst::Controller::DBIC::API.

list

Chained: "setup" PathPart: list CaptureArgs: 0

Provides an endpoint to the functionality described in "list" in Catalyst::Controller::DBIC::API.

delete

Chained: "object" PathPart: delete CaptureArgs: 0

Provides an endpoint to the functionality described in "delete" in Catalyst::Controller::DBIC::API.

update

Chained: "object" PathPart: update CaptureArgs: 0

Provides an endpoint to the functionality described in "update" in Catalyst::Controller::DBIC::API.

AUTHOR

  Luke Saunders <luke.saunders@gmail.com>

LICENSE

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

cpanm Catalyst::Controller::DBIC::API

perl -MCPAN -e shell
install Catalyst::Controller::DBIC::API