NAME

Shodo::Suzuri - Request and Reponse Parser for Shodo

Methods

request

    $suzuri->request($req);

Set HTTP::Request object.

response

    $suzuri->response($res);

Set HTTP::Response object.

params

    $suzuri->params(
        category => { isa => 'Str', documentation => 'Category of articles.' },
        limit => { isa => 'Int', default => 20, optional => 1, documentation => 'Limitation numbers per page.' },
        page => { isa => 'Int', default => 1, optional => 1, documentation => 'Page number you want to get.' }
    );

Parameters for validation and documentation. These rules are based on Data::Validator's interfaces.

validate

    $suzuri->validate($params);

Validate with the rules defined by "params" method. Parameter must be HASH ref.

doc

    $suzuri->doc();

Return the Markdown formatted document for Web API.

LICENSE

Copyright (C) Yusuke Wada.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

AUTHOR

Yusuke Wada <yusuke@kamawada.com>