Package org.apache.cxf.jaxrs.swagger.ui

Class SwaggerUiConfig

java.lang.Object

org.apache.cxf.jaxrs.swagger.ui.SwaggerUiConfig

public class SwaggerUiConfig
extends Object

Please refer to https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/configuration.md to get the idea what each parameter does.

Constructor Summary

Constructors

Constructor	Description
SwaggerUiConfig()

Method Summary

Modifier and Type	Method	Description
SwaggerUiConfig	configUrl(String cu)
SwaggerUiConfig	deepLinking(Boolean value)
SwaggerUiConfig	defaultModelExpandDepth(Integer value)
SwaggerUiConfig	defaultModelRendering(String value)
SwaggerUiConfig	defaultModelsExpandDepth(Integer value)
SwaggerUiConfig	displayOperationId(Boolean value)
SwaggerUiConfig	displayRequestDuration(Boolean value)
SwaggerUiConfig	docExpansion(String value)
SwaggerUiConfig	filter(String f)
Map<String,String>	getConfigParameters()
String	getConfigUrl()
Boolean	getDeepLinking()
Integer	getDefaultModelExpandDepth()
String	getDefaultModelRendering()
Integer	getDefaultModelsExpandDepth()
Boolean	getDisplayOperationId()
Boolean	getDisplayRequestDuration()
String	getDocExpansion()
String	getFilter()
Integer	getMaxDisplayedTags()
Boolean	getShowCommonExtensions()
Boolean	getShowExtensions()
String	getUrl()
String	getValidatorUrl()
Boolean	isQueryConfigEnabled()
Boolean	isTryItOutEnabled()
SwaggerUiConfig	maxDisplayedTags(Integer value)
protected static void	put(String name, Boolean value, Map<String,String> params)
protected static void	put(String name, Integer value, Map<String,String> params)
protected static void	put(String name, String value, Map<String,String> params)
SwaggerUiConfig	queryConfigEnabled(boolean enabled)
void	setConfigUrl(String configUrl)
void	setDeepLinking(Boolean deepLinking)
void	setDefaultModelExpandDepth(Integer defaultModelExpandDepth)
void	setDefaultModelRendering(String defaultModelRendering)
void	setDefaultModelsExpandDepth(Integer defaultModelsExpandDepth)
void	setDisplayOperationId(Boolean displayOperationId)
void	setDisplayRequestDuration(Boolean displayRequestDuration)
void	setDocExpansion(String docExpansion)
void	setFilter(String filter)
void	setMaxDisplayedTags(Integer maxDisplayedTags)
void	setQueryConfigEnabled(Boolean queryConfigEnabled)
void	setShowCommonExtensions(Boolean showCommonExtensions)
void	setShowExtensions(Boolean showExtensions)
void	setTryItOutEnabled(Boolean tryItOutEnabled)
void	setUrl(String url)
void	setValidatorUrl(String validatorUrl)
SwaggerUiConfig	showCommonExtensions(Boolean value)
SwaggerUiConfig	showExtensions(Boolean value)
SwaggerUiConfig	tryItOutEnabled(boolean tryItOut)
SwaggerUiConfig	url(String u)
SwaggerUiConfig	validatorUrl(String value)

Methods inherited from class java.lang.Object

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

Constructor Detail

SwaggerUiConfig

public SwaggerUiConfig()

Method Detail

getConfigUrl

public String getConfigUrl()

setConfigUrl

public void setConfigUrl(String configUrl)

getUrl

public String getUrl()

setUrl

public void setUrl(String url)

getFilter

public String getFilter()

setFilter

public void setFilter(String filter)

getShowCommonExtensions

public Boolean getShowCommonExtensions()

setShowCommonExtensions

public void setShowCommonExtensions(Boolean showCommonExtensions)

getShowExtensions

public Boolean getShowExtensions()

getMaxDisplayedTags

public Integer getMaxDisplayedTags()

setMaxDisplayedTags

public void setMaxDisplayedTags(Integer maxDisplayedTags)

maxDisplayedTags

public SwaggerUiConfig maxDisplayedTags(Integer value)

setShowExtensions

public void setShowExtensions(Boolean showExtensions)

getDocExpansion

public String getDocExpansion()

setDocExpansion

public void setDocExpansion(String docExpansion)

getDisplayRequestDuration

public Boolean getDisplayRequestDuration()

setDisplayRequestDuration

public void setDisplayRequestDuration(Boolean displayRequestDuration)

getDefaultModelRendering

public String getDefaultModelRendering()

setDefaultModelRendering

public void setDefaultModelRendering(String defaultModelRendering)

getDefaultModelExpandDepth

public Integer getDefaultModelExpandDepth()

setDefaultModelExpandDepth

public void setDefaultModelExpandDepth(Integer defaultModelExpandDepth)

getDefaultModelsExpandDepth

public Integer getDefaultModelsExpandDepth()

setDefaultModelsExpandDepth

public void setDefaultModelsExpandDepth(Integer defaultModelsExpandDepth)

getDisplayOperationId

public Boolean getDisplayOperationId()

setDisplayOperationId

public void setDisplayOperationId(Boolean displayOperationId)

getDeepLinking

public Boolean getDeepLinking()

setDeepLinking

public void setDeepLinking(Boolean deepLinking)

getValidatorUrl

public String getValidatorUrl()

setValidatorUrl

public void setValidatorUrl(String validatorUrl)

validatorUrl

public SwaggerUiConfig validatorUrl(String value)

deepLinking

public SwaggerUiConfig deepLinking(Boolean value)

displayOperationId

public SwaggerUiConfig displayOperationId(Boolean value)

defaultModelsExpandDepth

public SwaggerUiConfig defaultModelsExpandDepth(Integer value)

defaultModelExpandDepth

public SwaggerUiConfig defaultModelExpandDepth(Integer value)

defaultModelRendering

public SwaggerUiConfig defaultModelRendering(String value)

displayRequestDuration

public SwaggerUiConfig displayRequestDuration(Boolean value)

docExpansion

public SwaggerUiConfig docExpansion(String value)

showExtensions

public SwaggerUiConfig showExtensions(Boolean value)

showCommonExtensions

public SwaggerUiConfig showCommonExtensions(Boolean value)

url

public SwaggerUiConfig url(String u)

configUrl

public SwaggerUiConfig configUrl(String cu)

queryConfigEnabled

public SwaggerUiConfig queryConfigEnabled(boolean enabled)

filter

public SwaggerUiConfig filter(String f)

tryItOutEnabled

public SwaggerUiConfig tryItOutEnabled(boolean tryItOut)

isQueryConfigEnabled

public Boolean isQueryConfigEnabled()

setQueryConfigEnabled

public void setQueryConfigEnabled(Boolean queryConfigEnabled)

getConfigParameters

public Map<String,String> getConfigParameters()

put

protected static void put(String name,
                          Integer value,
                          Map<String,String> params)

put

protected static void put(String name,
                          Boolean value,
                          Map<String,String> params)

put

protected static void put(String name,
                          String value,
                          Map<String,String> params)

isTryItOutEnabled

public Boolean isTryItOutEnabled()

setTryItOutEnabled

public void setTryItOutEnabled(Boolean tryItOutEnabled)