Clustericious::Plugin::CommonRoutes - Routes common to all clustericious applications
version 1.24
# Mojolicious $self->plugin('Clustericious::Plugin::CommonRoutes'); # Clustericious # ... included by default ...
This plugin adds routes that are common to all clustericious servers. It is available to Vanilla Mojolicious apps that want to work with Clustericious::Client based clients.
Returns the version of the service as a single element list.
Returns status information about the service. This comes back as a hash that includes these key/value pairs:
The name of the application (example: "MyApp")
The server on which the service is running.
The URL to use for the service.
The version of the application.
Returns a list of API routes for the service. This is similar to the information provided by the Mojolicious::Command::routes.
If you are using Module::Build::Database and Route::Planter for a database back end to your application you can get the columns of each table using this route.
Return the last several lines from the application log (number specified by :lines and defaults to 10 if not specified).
Only available if you set export_logs to true in your application's server configuration.
example ~/etc/MyApp.conf:
~/etc/MyApp.conf
--- export_logs: 1
This route is NOT made available to non Clustericious applications.
This plugin pulls in the Clustericious::Plugin::AutodataHandler plugin if it hasn't already been loaded.
Clustericious, Clustericious::RouteBuilder
Original author: Brian Duggan
Current maintainer: Graham Ollis <plicease@cpan.org>
Contributors:
Curt Tilmes
This software is copyright (c) 2013 by NASA GSFC.
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 Clustericious, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Clustericious
CPAN shell
perl -MCPAN -e shell install Clustericious
For more information on module installation, please visit the detailed CPAN module installation guide.