Alexander Hartmaier > Catalyst-Controller-DBIC-API-2.004003 > Catalyst::Controller::DBIC::API::REST

Download:
Catalyst-Controller-DBIC-API-2.004003.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
Stalled  1
View/Report Bugs
Module Version: 2.004003   Source   Latest Release: Catalyst-Controller-DBIC-API-2.006002

NAME ^

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

VERSION ^

version 2.004003

DESCRIPTION ^

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

By default provides the following endpoints:

  $base (operates on lists of objects and accepts GET, PUT, POST and DELETE)
  $base/[identifier] (operates on a single object and accepts GET, PUT, 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' } },
        ...
  );

update_or_create_objects

Chained: "objects_no_id" PathPart: none Args: 0 Method: POST/PUT

Calls "update_or_create" in Catalyst::Controller::DBIC::API.

delete_many_objects

Chained: "objects_no_id" PathPart: none Args: 0 Method: DELETE

Calls "delete" in Catalyst::Controller::DBIC::API.

list_objects

Chained: "objects_no_id" PathPart: none Args: 0 Method: GET

Calls "list" in Catalyst::Controller::DBIC::API.

update_or_create_one_object

Chained: "object_with_id" PathPart: none Args: 0 Method: POST/PUT

Calls "update_or_create" in Catalyst::Controller::DBIC::API.

delete_one_object

Chained: "object_with_id" PathPart: none Args: 0 Method: DELETE

Calls "delete" in Catalyst::Controller::DBIC::API.

list_one_object

Chained: "object_with_id" PathPart: none Args: 0 Method: GET

Calls "item" in Catalyst::Controller::DBIC::API.

AUTHORS ^

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2011 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.

syntax highlighting: