/ 
Raisin-0.59
River stage one • 1 direct dependent • 1 total dependent
43 ++
/ Raisin::Plugin::Swagger

NAME

Raisin::Plugin::Swagger - Generate API documentation.

SYNOPSIS

    plugin 'Swagger';

DESCRIPTION

Generate Swagger compatible API documentaions.

Provides documentation in Swagger compatible format by /api-docs URL. You can use this url in Swagger UI.

CORS

Cross-origin resource sharing

    plugin 'Swagger', enable => 'CORS';

VERSION

Which Swagger version to use. By default 2.0 is used, also 1.2 available.

    plugin 'Swagger', version => 1.2;

FUNCTIONS

swagger_setup

    swagger_setup(
        title => 'BatAPI',
        description => 'Simple BatAPI.',

        contact => {
            name => 'Bruce Wayne',
            url => 'http://wayne.enterprises',
            email => 'bruce@batman.com',
        },

        license => {
            name => 'Barman license',
            url => 'http://wayne.enterprises/licenses/',
        },
    );

title, description, terms_of_service

contact: name, url, email

license: name, url

AUTHOR

Artur Khabibullin - rtkh <at> cpan.org

LICENSE

This module and all the modules in this package are governed by the same license as Perl itself.