View on
MetaCPAN
Graham Ollis > Clustericious-1.29 > Clustericious::Plugin::CommonRoutes

Download:
Clustericious-1.29.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 1.29   Source  

NAME ^

Clustericious::Plugin::CommonRoutes - Routes common to all clustericious applications

VERSION ^

version 1.29

SYNOPSIS ^

 # Mojolicious
 $self->plugin('Clustericious::Plugin::CommonRoutes');
 
 # Clustericious
 # ... included by default ...

DESCRIPTION ^

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.

/version

Returns the version of the service as a single element list.

/status

Returns status information about the service. This comes back as a hash that includes these key/value pairs:

app_name

The name of the application (example: "MyApp")

server_hostname

The server on which the service is running.

server_url

The URL to use for the service.

server_version

The version of the application.

/api

Returns a list of API routes for the service. This is similar to the information provided by the Mojolicious::Command::routes.

/api/:table

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.

/log/:lines

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:

 ---
 export_logs: 1

This route is NOT made available to non Clustericious applications.

CAVEATS ^

This plugin pulls in the Clustericious::Plugin::AutodataHandler plugin if it hasn't already been loaded.

SEE ALSO ^

Clustericious, Clustericious::RouteBuilder

AUTHOR ^

Original author: Brian Duggan

Current maintainer: Graham Ollis <plicease@cpan.org>

Contributors:

Curt Tilmes

Yanick Champoux

COPYRIGHT AND LICENSE ^

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.

syntax highlighting: