NAME

Dancer2::Plugin::Swagger2 - A Dancer2 plugin for creating routes from a Swagger2 spec

VERSION

version 0.001

SYNOPSIS

example/my_app.pl:

#!/usr/bin/env perl

use lib '../lib';

use Dancer2;
use Dancer2::Plugin::Swagger2;

swagger2( url => path( dirname(__FILE__), 'swagger2.yaml' ) );

sub my_controller {
    return "Hello World!\n";
}

dance;

example/swagger2.pl:

---
swagger: "2.0"
info:
  title: MyApp's API
  version: "1.0"
basePath: /api
paths:
  /welcome:
    get:
      operationId: my_controller
      responses:
        200:
          description: success

Then on the terminal run:

perl my_app.pl
curl http://localhost:3000/api/welcome

You'll find the example files displayed above in the distribution and repository.

DEBUGGING

To see some more debug messages on STDERR set environment variable SWAGGER2_DEBUG to a true value.

METHODS

swagger2( url => $url, ... )

Import routes from Swagger file. Named arguments:

url: URL to passed to Swagger2 module

controller_factory: custom callback generator/finder that returns callbacks to routes

validate_spec: boolish value (default: true) telling if Swagger2 file shall be validated by official Swagger specification

validate_requests: boolish value (default: same as validate_spec) telling if HTTP requests shall be validated by loaded specification (needs validate_spec to be true)

validate_responses: boolish value (default: same as validate_spec) telling if HTTP responses shall be validated by loaded specification (needs validate_spec to be true)

default_controller_factory

Default method for finding a callback for a given operationId. Can be overriden by the controller_factory argument to swagger2 or config option.

The default uses the controller argument/config option or the name of the app (possibly with ::Controller appended). If the operationId looks like a Perl module the module name is tried under the namespace mentioned above and as a top level module name.

The module warns as long as controller modules or methods can't be found and returns a coderef on the first match.

ACKNOWLEDGEMENT

This software has been developed with support from STRATO. In German: Diese Software wurde mit Unterstützung von STRATO entwickelt.

AUTHORS

• Daniel Böhmer <dboehmer@cpan.org>

• Tina Müller <cpan2@tinita.de>

COPYRIGHT AND LICENSE

This software is copyright (c) 2016 by Daniel Böhmer.

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