io.federecio.dropwizard.swagger

Class SwaggerBundleConfiguration

java.lang.Object

io.federecio.dropwizard.swagger.SwaggerBundleConfiguration

public class SwaggerBundleConfiguration
extends Object

For the meaning of all these properties please refer to Swagger documentation or BeanConfig

Constructor Summary

Constructors

Constructor and Description
SwaggerBundleConfiguration()

Method Summary

Modifier and Type	Method and Description
io.swagger.jaxrs.config.BeanConfig	build(String urlPattern)
String	getContact()
String	getContactEmail()
String	getContactUrl()
String	getContextRoot()
String	getDescription()
String	getHost()
String	getLicense()
String	getLicenseUrl()
String	getResourcePackage()
String[]	getSchemes()
SwaggerOAuth2Configuration	getSwaggerOAuth2Configuration()
SwaggerViewConfiguration	getSwaggerViewConfiguration()
String	getTermsOfServiceUrl()
String	getTitle()
String	getUriPrefix()
String	getVersion()
boolean	isEnabled()
boolean	isIncludeSwaggerResource()
boolean	isPrettyPrint()
void	setContact(String contact)
void	setContactEmail(String contactEmail)
void	setContactUrl(String contactUrl)
void	setContextRoot(String contextRoot)
void	setDescription(String description)
void	setHost(String host)
void	setIncludeSwaggerResource(boolean include)
void	setIsEnabled(boolean isEnabled)
void	setIsPrettyPrint(boolean isPrettyPrint)
void	setLicense(String license)
void	setLicenseUrl(String licenseUrl)
void	setResourcePackage(String resourcePackage)
void	setSchemes(String[] schemes)
void	setSwaggerOAuth2Configuration(SwaggerOAuth2Configuration swaggerOAuth2Configuration)
void	setSwaggerViewConfiguration(SwaggerViewConfiguration swaggerViewConfiguration)
void	setTermsOfServiceUrl(String termsOfServiceUrl)
void	setTitle(String title)
void	setUriPrefix(String uriPrefix)
void	setVersion(String version)

Methods inherited from class java.lang.Object

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

Constructor Detail

SwaggerBundleConfiguration

public SwaggerBundleConfiguration()

Method Detail

getResourcePackage

public String getResourcePackage()

setResourcePackage

public void setResourcePackage(String resourcePackage)

getTitle

@Nullable
public String getTitle()

setTitle

public void setTitle(@Nullable
                     String title)

getVersion

@Nullable
public String getVersion()

setVersion

public void setVersion(@Nullable
                       String version)

getDescription

@Nullable
public String getDescription()

setDescription

public void setDescription(@Nullable
                           String description)

getTermsOfServiceUrl

@Nullable
public String getTermsOfServiceUrl()

setTermsOfServiceUrl

public void setTermsOfServiceUrl(@Nullable
                                 String termsOfServiceUrl)

getContact

@Nullable
public String getContact()

setContact

public void setContact(@Nullable
                       String contact)

getContactEmail

@Nullable
public String getContactEmail()

setContactEmail

public void setContactEmail(@Nullable
                            String contactEmail)

getContactUrl

@Nullable
public String getContactUrl()

setContactUrl

public void setContactUrl(@Nullable
                          String contactUrl)

getLicense

@Nullable
public String getLicense()

setLicense

public void setLicense(@Nullable
                       String license)

getLicenseUrl

@Nullable
public String getLicenseUrl()

setLicenseUrl

public void setLicenseUrl(@Nullable
                          String licenseUrl)

getUriPrefix

@Nullable
public String getUriPrefix()

setUriPrefix

public void setUriPrefix(@Nullable
                         String uriPrefix)

getSwaggerViewConfiguration

public SwaggerViewConfiguration getSwaggerViewConfiguration()

setSwaggerViewConfiguration

public void setSwaggerViewConfiguration(SwaggerViewConfiguration swaggerViewConfiguration)

getSwaggerOAuth2Configuration

public SwaggerOAuth2Configuration getSwaggerOAuth2Configuration()

setSwaggerOAuth2Configuration

public void setSwaggerOAuth2Configuration(SwaggerOAuth2Configuration swaggerOAuth2Configuration)

isPrettyPrint

public boolean isPrettyPrint()

setIsPrettyPrint

public void setIsPrettyPrint(boolean isPrettyPrint)

getHost

@Nullable
public String getHost()

setHost

public void setHost(@Nullable
                    String host)

getContextRoot

public String getContextRoot()

setContextRoot

public void setContextRoot(String contextRoot)

getSchemes

public String[] getSchemes()

setSchemes

public void setSchemes(String[] schemes)

isEnabled

public boolean isEnabled()

setIsEnabled

public void setIsEnabled(boolean isEnabled)

isIncludeSwaggerResource

public boolean isIncludeSwaggerResource()

setIncludeSwaggerResource

public void setIncludeSwaggerResource(boolean include)

build

public io.swagger.jaxrs.config.BeanConfig build(String urlPattern)