File Coverage

blib/lib/Mojolicious/Plugin/SwaggerUI.pm

Criterion	Covered	Total	%
statement	21	21	100.0
branch	1	2	50.0
condition	4	10	40.0
subroutine	4	4	100.0
pod	1	1	100.0
total	31	38	81.5

package Mojolicious::Plugin::SwaggerUI;

use Mojo::Base 'Mojolicious::Plugin';
use Mojo::File qw(path);

use File::ShareDir qw(dist_dir);

our $VERSION = '0.0.4';

sub register {
    my ($self, $app, $config) = @_;

    my $prefix = $config->{route} // $app->routes()->any('/swagger-ui');

    # --- Configuring the Mojolicious path resolvers
    my $resources = path(dist_dir('Mojolicious-Plugin-SwaggerUI'))
        ->child('resources');

    push(@{$app->static()->paths()}, $resources->child('public')->to_string());
    push(@{$app->renderer()->paths()}, $resources->child('templates')->to_string());

    # --- Adding the route
    my $url = $config->{url} // '/v1';
    my $title = $config->{title} // 'Swagger UI';
    my $favicon
        = (defined $config->{favicon} and $app->static()->file($config->{favicon}))
        ? $config->{favicon}
        : undef;

    $prefix->get(q(/) => { url => $url, title => $title, favicon => $favicon })
        ->name('swagger_ui');

    return;
}

1;

=encoding utf8

=head1 NAME

Mojolicious::Plugin::SwaggerUI - Swagger UI plugin for Mojolicious

=head1 SYNOPSIS

    # Mojolicious Lite
    plugin 'SwaggerUI' => {
        route => app->routes()->any('/swagger'),
        url => '/swagger.json',
    };

    # Mojolicious Full
    $app->plugin(
        SwaggerUI => {
            route   => $app->routes()->any('api'),
            url     => "/api/v1",
            title   => "Mojolicious App",
            favicon => "/images/favicon.png"
        }
    );

=head1 DESCRIPTION

The plugin allows you to run the Swagger UI component inside your Mojolicious application.

=begin html



        src="https://gitlab.com/marghidanu/mojolicious-plugin-swaggerui/raw/master/share/images/Screenshot.png?inline=true">


=end html

=head1 OPTIONS

=head2 route

    plugin 'SwaggerUI' => {
        route => app()->routes()->any('/swagger')
    };

Route for the swagger-ui component. It defaults to a any route on C

=head2 url

    plugin 'SwaggerUI' => {
        url => '/swagger.json'
    };

Url for the JSON Swagger specification. It defaults to C.

B
L can expose the JSON Swagger spec under the base path route.
You can just point the path in her and it will automatically work.

=head2 title

    plugin 'SwaggerUI' => {
        title => 'Project Title'
    };

The HTML title that you want to show on swagger-ui page. Deafult to 'Swagger UI'

=head2 favicon

    plugin 'SwaggerUI' => {
        favicon => '/images/favicon.png'
    };

Favicon which you want to associate with swagger-ui page.

It will be served automatically from a 'public' directory if it exists.
In case of non existence mojolicious default favicon will be displayed.

=head1 AUTHOR

Tudor Marghidanu C

=head1 CREDITS

Gaurav Rai C

=head1 COPYRIGHT AND LICENSE

Copyright (C) 2019, Tudor Marghidanu.

This program is free software, you can redistribute it and/or modify it under the terms of the Artistic License version 2.0.

=cut

__END__