io.federecio.dropwizard.swagger

Class SwaggerView

java.lang.Object

io.dropwizard.views.View

io.federecio.dropwizard.swagger.SwaggerView

public class SwaggerView
extends io.dropwizard.views.View

Serves the content of Swagger's index page which has been "templatized" to support replacing the directory in which Swagger's static content is located (i.e. JS files) and the path with which requests to resources need to be prefixed.

Constructor Summary

Constructors

Constructor and Description
SwaggerView(String contextRoot, String urlPattern, SwaggerViewConfiguration viewConfiguration, SwaggerOAuth2Configuration oauth2Configuration)

Method Summary

Modifier and Type	Method and Description
String	getContextPath() Returns the path with with which all requests made by Swagger's UI to Resources need to be prefixed
SwaggerOAuth2Configuration	getOauth2Configuration()
boolean	getShowApiSelector() Returns whether to display the swagger spec selector
boolean	getShowAuth() Returns whether to display the authorization input boxes
String	getSwaggerAssetsPath() Returns the path with which all requests for Swagger's static content need to be prefixed
String	getTitle() Returns the title for the browser header
String	getValidatorUrl() Returns the location of the validator URL or null to disable

Methods inherited from class io.dropwizard.views.View

getCharset, getTemplateName

Methods inherited from class java.lang.Object

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

Constructor Detail

SwaggerView

public SwaggerView(@Nonnull
                   String contextRoot,
                   @Nonnull
                   String urlPattern,
                   @Nonnull
                   SwaggerViewConfiguration viewConfiguration,
                   @Nonnull
                   SwaggerOAuth2Configuration oauth2Configuration)

Method Detail

getTitle

@Nullable
public String getTitle()

Returns the title for the browser header

getSwaggerAssetsPath

public String getSwaggerAssetsPath()

Returns the path with which all requests for Swagger's static content need to be prefixed

getContextPath

public String getContextPath()

Returns the path with with which all requests made by Swagger's UI to Resources need to be prefixed

getValidatorUrl

@Nullable
public String getValidatorUrl()

Returns the location of the validator URL or null to disable

getShowAuth

public boolean getShowAuth()

Returns whether to display the authorization input boxes

getShowApiSelector

public boolean getShowApiSelector()

Returns whether to display the swagger spec selector

getOauth2Configuration

public SwaggerOAuth2Configuration getOauth2Configuration()

Returns:

SwaggerOAuth2Configuration containing every properties to init oauth2