com.alexeinunez.dropwizard.swagger

Class SwaggerBundle<T extends io.dropwizard.Configuration & SwaggerBundleConfiguration>

java.lang.Object

com.alexeinunez.dropwizard.swagger.SwaggerBundle<T>

All Implemented Interfaces:

io.dropwizard.ConfiguredBundle<T>

public class SwaggerBundle<T extends io.dropwizard.Configuration & SwaggerBundleConfiguration>
extends Object
implements io.dropwizard.ConfiguredBundle<T>

A Bundle which adds functionality for automatically finding and processing resources annotated with Swagger to expose a Swagger Spec. Additionally, a view is exposed for displaying the Swagger Spec with Swagger UI, a UI able to interact with any API exposing a Swagger Spec.

The Swagger Spec endpoint is "/api-docs" and the Swagger UI endpoing is "/swagger".

Field Summary

Fields

Modifier and Type	Field and Description
static String	ROOT_ASSETS_PATH
static String	SWAGGER_SPEC_PATH

Constructor Summary

Constructors

Constructor and Description
SwaggerBundle() Renders a DefaultSwaggerView
SwaggerBundle(SwaggerView view)

Method Summary

Methods

Modifier and Type	Method and Description
void	initialize(io.dropwizard.setup.Bootstrap<?> bootstrap)
void	run(T configuration, io.dropwizard.setup.Environment environment)

Methods inherited from class java.lang.Object

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

Field Detail

ROOT_ASSETS_PATH

public static final String ROOT_ASSETS_PATH

See Also:

Constant Field Values

SWAGGER_SPEC_PATH

public static final String SWAGGER_SPEC_PATH

See Also:

Constant Field Values

Constructor Detail

SwaggerBundle

public SwaggerBundle()

Renders a DefaultSwaggerView

SwaggerBundle

public SwaggerBundle(SwaggerView view)

Parameters:

view - the view to be rendered at "/swagger"

Method Detail

initialize

public void initialize(io.dropwizard.setup.Bootstrap<?> bootstrap)

Specified by:

initialize in interface io.dropwizard.ConfiguredBundle<T extends io.dropwizard.Configuration & SwaggerBundleConfiguration>

run

public void run(T configuration,
       io.dropwizard.setup.Environment environment)
         throws Exception

Specified by:

run in interface io.dropwizard.ConfiguredBundle<T extends io.dropwizard.Configuration & SwaggerBundleConfiguration>

Throws:

Exception