Dancer::Plugin::RPC::RESTISH - Simple plugin to implement a restish interface.
In the Controler-bit:
use Dancer::Plugin::RPC::RESTISH; restish '/endpoint' => { publish => 'pod', arguments => ['MyProject::Admin'], cors_allow_origin => '*', };
and in the Model-bit (MyProject::Admin):
package MyProject::Admin; =for restish GET@ability/:id rpc_get_ability_details =cut sub rpc_get_ability_details { my %args = @_; # contains: {"id": 42} return { # datastructure }; } 1;
RESTISH is an implementation of REST that lets you bind routes to code in the style the rest of Dancer::Plugin::RPC modules do.
This version only supports JSON as data serialisation.
See Dancer::Plugin::RPC, Dancer::Plugin::RPC::JSONRPC, Dancer::Plugin::RPC::RESTRPC, Dancer::Plugin::RPC::XMLRPC for more information about the %publisher_arguments.
%publisher_arguments
The plugin registers Dancer-any route-handlers for the base_path + method_path and the route-handler looks for a data-handler that matches the path and HTTP-method.
any
base_path
method_path
Method-paths can contain colon-prefixed parameters native to Dancer. These parameters will be merged with the content.
Method-paths are prefixed by a HTTP-method followed by @:
plugins: 'RPC::RESTISH': '/rest': 'MyProject::Admin': 'GET@resources': 'get_all_resourses' 'POST@resource': 'create_resource' 'GET@resource/:id': 'get_resource' 'PATCH@resource/:id': 'update_resource' 'DELETE@resource/:id': 'delete_resource'
=for restish GET@resources get_all_resources /rest =for restish POST@resource create_resource /rest =for restish GET@resource/:id get_resource /rest =for restish PATCH@resource/:id update_resource /rest =for restish DELETE@resource/:id delete_resource /rest
The third argument (the base_path) is optional.
If one wants the service to be directly called from javascript in a browser, one has to consider CORS as browsers enforce that. This means that the actual request is preceded by what's called a preflight request that uses the HTTP-method OPTIONS with a number of header-fields.
The plugin supports considering these CORS requests, by special casing these OPTIONS request and always sending the Access-Control-Allow-Origin header as set in the config options.
Access-Control-Allow-Origin
If left out, no attempt to honour a CORS OPTIONS request will be done.
When set to a value, the OPTIONS request will be executed, for any method in the Access-Control-Request-Method header. The responnse to the OPTIONS request will also contain every Access-Control-Allow-* header that was requested as Access-Control-Request-* header.
Access-Control-Request-Method
Access-Control-Allow-*
Access-Control-Request-*
When set all responses, will contain the Access-Control-Allow-Origin header with that value.
Creates a (partial) dispatch table from data passed from the (YAML)-config file.
Creates a (partial) dispatch table from data provided in POD.
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
See:
http://www.perl.com/perl/misc/Artistic.html
http://www.gnu.org/copyleft/gpl.html
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
(c) MMXIX - Abe Timmerman <abeltje@cpan.org>
To install Dancer::Plugin::RPC::RESTISH, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Dancer::Plugin::RPC::RESTISH
CPAN shell
perl -MCPAN -e shell install Dancer::Plugin::RPC::RESTISH
For more information on module installation, please visit the detailed CPAN module installation guide.