Catalyst::Controller::DBIC::API::RPC - Provides an RPC interface to DBIx::Class
version 2.008001
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] $base/id/[identifier]/delete $base/id/[identifier]/update
Where $base is the URI described by "setup", the chain root of the controller.
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.
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' } }, ... );
Chained: "objects_no_id" PathPart: create CaptureArgs: 0
Provides an endpoint to the functionality described in "update_or_create" in Catalyst::Controller::DBIC::API.
Chained: "deserialize" PathPart: list CaptureArgs: 0
Provides an endpoint to the functionality described in "list" in Catalyst::Controller::DBIC::API.
Chained: "object_with_id" PathPart: '' Args: 0
Provides an endpoint to the functionality described in "item" in Catalyst::Controller::DBIC::API.
Chained: "object_with_id" PathPart: update Args: 0
Chained: "object_with_id" PathPart: delete Args: 0
Provides an endpoint to the functionality described in "delete" in Catalyst::Controller::DBIC::API.
Chained: "objects_no_id" PathPart: update Args: 0
Provides an endpoint to the functionality described in "update_or_create" in Catalyst::Controller::DBIC::API for multiple objects.
Chained: "objects_no_id" PathPart: delete Args: 0
Provides an endpoint to the functionality described in "delete" in Catalyst::Controller::DBIC::API for multiple objects.
Nicholas Perez <nperez@cpan.org>
Luke Saunders <luke.saunders@gmail.com>
Alexander Hartmaier <abraxxa@cpan.org>
Florian Ragwitz <rafl@debian.org>
Oleg Kostyuk <cub.uanic@gmail.com>
Samuel Kaufman <sam@socialflow.com>
This software is copyright (c) 2019 by Luke Saunders, Nicholas Perez, Alexander Hartmaier, 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.
To install Catalyst::Controller::DBIC::API, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Catalyst::Controller::DBIC::API
CPAN shell
perl -MCPAN -e shell install Catalyst::Controller::DBIC::API
For more information on module installation, please visit the detailed CPAN module installation guide.