NAME

App::Dochazka::REST::Dispatch - path dispatch

VERSION

Version 0.087

DESCRIPTION

This module contains the state machine that converts incoming HTTP requests into JSON responses.

REQUEST SYNTAX

Documentation of App::Dochazka::REST request syntax. Each section below corresponds to a URL, in which you should replace dochazka.site with the FQDN of your own Dochazka REST server. The full URL is shown only for the first couple entries. All responses are JSON-encoded status objects unless otherwise noted.

http://dochazka.site/

(If this URL is opened in a browser, a HTML page will be displayed. The HTML source code is defined in $site->DOCHAZKA_REST_HTML.)

This is considered an empty request. The response will be the same as for "/dochazka.site/version"" in "http:.

http://dochazka.site/version

Returns version number of the App::Dochazka::REST that is installed at the site. For example:

    /VERSION example here

http://dochazka.site/help

Returns a hopefully helpful status object containing a URL where documentation can be accessed.

/site/[PARAM]

(For the sake of brevity, the http://dochazka.site part will be omitted from here on.)

Returns value of the given site param in the payload.