Catalyst::Controller::DBIC::API 2.002003

Easily provide common API endpoints based on your DBIx::Class schema classes. Module provides both RPC and REST interfaces to base functionality. Uses Catalyst::Action::Serialize and Catalyst::Action::Deserialize to serialise response and/or deserialise request.<br /><br />This document describes base functionlity such as list, create, delete, update and the setting of config attributes. Catalyst::Controller::DBIC::API::RPC and Catalyst::Controller::DBIC::API::REST describe details of provided endpoints to those base methods.<br /><br />You will need to create a controller for each schema class you require API endpoints for. For example if your schema has Artist and Track, and you want to provide a RESTful interface to these, you should create MyApp::Controller::API::REST::Artist and MyApp::Controller::API::REST::Track which both subclass Catalyst::Controller::DBIC::API::REST. Similarly if you wanted to provide an RPC style interface then subclass Catalyst::Controller::DBIC::API::RPC. You then configure these individually as specified in "CONFIGURATION".<br /><br />Also note that the test suite of this module has an example application used to run tests against. It maybe helpful to look at that until a better tutorial is written.

Requirements:	No special requirements
Platforms:	*nix, Linux
Keyword:	Artist,  Catalystcontrollerdbicapirest,  Catalystcontrollerdbicapirpc,  Create,  Endpoints,  Individually,  Interface,  Myappcontrollerapirestartist,  Myappcontrollerapiresttrack,  Provide,  Restful,  Schema,  Similarly,  Subclass,  Track,  Wanted
Users rating:	0/10