io.federecio.dropwizard.swagger

Class SwaggerBundle

java.lang.Object

io.dropwizard.assets.AssetsBundle

io.federecio.dropwizard.swagger.SwaggerBundle

All Implemented Interfaces:

io.dropwizard.Bundle

public class SwaggerBundle
extends io.dropwizard.assets.AssetsBundle

Author:

Federico Recio

Field Summary

Fields

Modifier and Type	Field and Description
static String	PATH

Constructor Summary

Constructors

Constructor and Description
SwaggerBundle()

Method Summary

Methods

Modifier and Type	Method and Description
static void	configure(io.dropwizard.Configuration configuration) Call this method from Application.run(io.dropwizard.Configuration, io.dropwizard.setup.Environment) passing the Configuration so that Swagger can be properly configured to run on Amazon.
static void	configure(io.dropwizard.Configuration configuration, String host) Call this method directly if not running locally or in AWS and pass in the host to which Swagger API should be bound to.
void	run(io.dropwizard.setup.Environment environment)

Methods inherited from class io.dropwizard.assets.AssetsBundle

initialize

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PATH

public static final String PATH

See Also:

Constant Field Values

Constructor Detail

SwaggerBundle

public SwaggerBundle()

Method Detail

configure

public static void configure(io.dropwizard.Configuration configuration)
                      throws IOException

Call this method from Application.run(io.dropwizard.Configuration, io.dropwizard.setup.Environment) passing the Configuration so that Swagger can be properly configured to run on Amazon.

It is recommended that this method is called even when running locally -which has no side effect- so that this application can be deployed to an EC2 instance without any changes.

Throws:

IOException

configure

public static void configure(io.dropwizard.Configuration configuration,
             String host)

Call this method directly if not running locally or in AWS and pass in the host to which Swagger API should be bound to.

run

public void run(io.dropwizard.setup.Environment environment)

Specified by:

run in interface io.dropwizard.Bundle

Overrides:

run in class io.dropwizard.assets.AssetsBundle