AbstractSwaggerUiConfigProperties (springdoc-openapi-common 1.8.0 API)

java.lang.Object
- org.springdoc.core.AbstractSwaggerUiConfigProperties

Direct Known Subclasses:

SwaggerUiConfigParameters, SwaggerUiConfigProperties
```
public abstract class AbstractSwaggerUiConfigProperties
extends Object
```
Please refer to the swagger configuration.md to get the idea what each parameter does.

Author:

bnasslahsen

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AbstractSwaggerUiConfigProperties.SwaggerUrl
The type Swagger url.

Nested Classes
Modifier and Type	Class and Description
`static class`	`AbstractSwaggerUiConfigProperties.SwaggerUrl` The type Swagger url.

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`configUrl` URL to fetch external configuration document from.
`protected Boolean`	`deepLinking` Enables or disables deep linking for tags and operations.
`protected Integer`	`defaultModelExpandDepth` The default expansion depth for the model on the model-example section.
`protected String`	`defaultModelRendering` Controls how the model is shown when the API is first rendered.
`protected Integer`	`defaultModelsExpandDepth` The default expansion depth for models (set to -1 completely hide the models).
`protected Boolean`	`displayOperationId` Controls the display of operationId in operations list.
`protected Boolean`	`displayRequestDuration` Controls the display of the request duration (in milliseconds) for Try-It-Out requests.
`protected String`	`docExpansion` Controls the default expansion setting for the operations and tags.
`protected String`	`filter` If set, enables filtering.
`protected org.springdoc.core.AbstractSwaggerUiConfigProperties.Direction`	`groupsOrder` The Groups order.
`protected String`	`layout` The name of a component available via the plugin system to use as the top-level layout for Swagger UI.
`protected Integer`	`maxDisplayedTags` If set, limits the number of tagged operations displayed to at most this many.
`protected String`	`oauth2RedirectUrl` OAuth redirect URL.
`protected String`	`operationsSorter` Apply a sort to the operation list of each API
`protected String`	`path` The path for the Swagger UI pages to load.
`protected Boolean`	`persistAuthorization` The Persist authorization.
`protected Boolean`	`queryConfigEnabled` The Query config enabled.
`protected Boolean`	`showCommonExtensions` Controls the display of extensions
`protected Boolean`	`showExtensions` Controls the display of vendor extension (x-) fields and values.
`protected List<String>`	`supportedSubmitMethods` The supported try it out methods
`protected String`	`tagsSorter` Apply a sort to the tag list of each API
`protected Boolean`	`tryItOutEnabled` Try it out enabled
`protected String`	`url` The Url.
`protected Set<AbstractSwaggerUiConfigProperties.SwaggerUrl>`	`urls` The Urls.
`protected String`	`urlsPrimaryName` The Urls primary name.
`protected String`	`validatorUrl` URL to validate specs against.
`protected Boolean`	`withCredentials` The With credentials.

Constructor Summary

Constructors
Constructor and Description

AbstractSwaggerUiConfigProperties()

Constructors
Constructor and Description
`AbstractSwaggerUiConfigProperties()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getConfigUrl()` Gets config url.
`Boolean`	`getDeepLinking()` Gets deep linking.
`Integer`	`getDefaultModelExpandDepth()` Gets default model expand depth.
`String`	`getDefaultModelRendering()` Gets default model rendering.
`Integer`	`getDefaultModelsExpandDepth()` Gets default models expand depth.
`Boolean`	`getDisplayOperationId()` Gets display operation id.
`Boolean`	`getDisplayRequestDuration()` Gets display request duration.
`String`	`getDocExpansion()` Gets doc expansion.
`String`	`getFilter()` Gets filter.
`org.springdoc.core.AbstractSwaggerUiConfigProperties.Direction`	`getGroupsOrder()` Gets groups order.
`String`	`getLayout()` Gets layout.
`Integer`	`getMaxDisplayedTags()` Gets max displayed tags.
`String`	`getOauth2RedirectUrl()` Gets oauth 2 redirect url.
`String`	`getOperationsSorter()` Gets operations sorter.
`String`	`getPath()` Gets path.
`Boolean`	`getPersistAuthorization()` Gets persist authorization.
`Boolean`	`getQueryConfigEnabled()` Gets query config enabled.
`Boolean`	`getShowCommonExtensions()` Gets show common extensions.
`Boolean`	`getShowExtensions()` Gets show extensions.
`List<String>`	`getSupportedSubmitMethods()` Gets supported submit methods.
`String`	`getTagsSorter()` Gets tags sorter.
`Boolean`	`getTryItOutEnabled()` Gets try it out enabled
`String`	`getUrl()` Gets url.
`Set<AbstractSwaggerUiConfigProperties.SwaggerUrl>`	`getUrls()` Gets urls.
`String`	`getUrlsPrimaryName()` Gets urls primary name.
`String`	`getValidatorUrl()` Gets validator url.
`Boolean`	`getWithCredentials()` Gets with credentials.
`void`	`setConfigUrl(String configUrl)` Sets config url.
`void`	`setDeepLinking(Boolean deepLinking)` Sets deep linking.
`void`	`setDefaultModelExpandDepth(Integer defaultModelExpandDepth)` Sets default model expand depth.
`void`	`setDefaultModelRendering(String defaultModelRendering)` Sets default model rendering.
`void`	`setDefaultModelsExpandDepth(Integer defaultModelsExpandDepth)` Sets default models expand depth.
`void`	`setDisplayOperationId(Boolean displayOperationId)` Sets display operation id.
`void`	`setDisplayRequestDuration(Boolean displayRequestDuration)` Sets display request duration.
`void`	`setDocExpansion(String docExpansion)` Sets doc expansion.
`void`	`setFilter(String filter)` Sets filter.
`void`	`setGroupsOrder(org.springdoc.core.AbstractSwaggerUiConfigProperties.Direction groupsOrder)` Sets groups order.
`void`	`setLayout(String layout)` Sets layout.
`void`	`setMaxDisplayedTags(Integer maxDisplayedTags)` Sets max displayed tags.
`void`	`setOauth2RedirectUrl(String oauth2RedirectUrl)` Sets oauth 2 redirect url.
`void`	`setOperationsSorter(String operationsSorter)` Sets operations sorter.
`void`	`setPath(String path)` Sets path.
`void`	`setPersistAuthorization(Boolean persistAuthorization)` Sets persist authorization.
`void`	`setQueryConfigEnabled(Boolean queryConfigEnabled)` Sets query config enabled.
`void`	`setShowCommonExtensions(Boolean showCommonExtensions)` Sets show common extensions.
`void`	`setShowExtensions(Boolean showExtensions)` Sets show extensions.
`void`	`setSupportedSubmitMethods(List<String> supportedSubmitMethods)` Sets supported submit methods.
`void`	`setTagsSorter(String tagsSorter)` Sets tags sorter.
`void`	`setTryItOutEnabled(Boolean tryItOutEnabled)` Sets try it out enabled
`void`	`setUrl(String url)` Sets url.
`void`	`setUrls(Set<AbstractSwaggerUiConfigProperties.SwaggerUrl> urls)` Sets urls.
`void`	`setUrlsPrimaryName(String urlsPrimaryName)` Sets urls primary name.
`void`	`setValidatorUrl(String validatorUrl)` Sets validator url.
`void`	`setWithCredentials(Boolean withCredentials)` Sets with credentials.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - path
```
protected String path
```
    The path for the Swagger UI pages to load. Will redirect to the springdoc.webjars.prefix property.
  - layout
```
protected String layout
```
    The name of a component available via the plugin system to use as the top-level layout for Swagger UI.
  - configUrl
```
protected String configUrl
```
    URL to fetch external configuration document from.
  - validatorUrl
```
protected String validatorUrl
```
    URL to validate specs against.
  - filter
```
protected String filter
```
    If set, enables filtering. The top bar will show an edit box that could be used to filter the tagged operations that are shown.
  - operationsSorter
```
protected String operationsSorter
```
    Apply a sort to the operation list of each API
  - tagsSorter
```
protected String tagsSorter
```
    Apply a sort to the tag list of each API
  - deepLinking
```
protected Boolean deepLinking
```
    Enables or disables deep linking for tags and operations.
    
    See Also:
    
    deep-linking.md
  - displayOperationId
```
protected Boolean displayOperationId
```
    Controls the display of operationId in operations list.
  - defaultModelsExpandDepth
```
protected Integer defaultModelsExpandDepth
```
    The default expansion depth for models (set to -1 completely hide the models).
  - defaultModelExpandDepth
```
protected Integer defaultModelExpandDepth
```
    The default expansion depth for the model on the model-example section.
  - defaultModelRendering
```
protected String defaultModelRendering
```
    Controls how the model is shown when the API is first rendered.
  - displayRequestDuration
```
protected Boolean displayRequestDuration
```
    Controls the display of the request duration (in milliseconds) for Try-It-Out requests.
  - docExpansion
```
protected String docExpansion
```
    Controls the default expansion setting for the operations and tags.
  - maxDisplayedTags
```
protected Integer maxDisplayedTags
```
    If set, limits the number of tagged operations displayed to at most this many.
  - showExtensions
```
protected Boolean showExtensions
```
    Controls the display of vendor extension (x-) fields and values.
  - showCommonExtensions
```
protected Boolean showCommonExtensions
```
    Controls the display of extensions
  - supportedSubmitMethods
```
protected List<String> supportedSubmitMethods
```
    The supported try it out methods
  - oauth2RedirectUrl
```
protected String oauth2RedirectUrl
```
    OAuth redirect URL.
  - url
```
protected String url
```
    The Url.
  - urls
```
protected Set<AbstractSwaggerUiConfigProperties.SwaggerUrl> urls
```
    The Urls.
  - groupsOrder
```
protected org.springdoc.core.AbstractSwaggerUiConfigProperties.Direction groupsOrder
```
    The Groups order.
  - urlsPrimaryName
```
protected String urlsPrimaryName
```
    The Urls primary name.
  - tryItOutEnabled
```
protected Boolean tryItOutEnabled
```
    Try it out enabled
  - persistAuthorization
```
protected Boolean persistAuthorization
```
    The Persist authorization.
  - queryConfigEnabled
```
protected Boolean queryConfigEnabled
```
    The Query config enabled.
  - withCredentials
```
protected Boolean withCredentials
```
    The With credentials.
- Constructor Detail
  - AbstractSwaggerUiConfigProperties
```
public AbstractSwaggerUiConfigProperties()
```
- Method Detail
  - getWithCredentials
```
public Boolean getWithCredentials()
```
    Gets with credentials.
    
    Returns:
    
    the with credentials
  - setWithCredentials
```
public void setWithCredentials(Boolean withCredentials)
```
    Sets with credentials.
    
    Parameters:
    
    withCredentials - the with credentials
  - getQueryConfigEnabled
```
public Boolean getQueryConfigEnabled()
```
    Gets query config enabled.
    
    Returns:
    
    the query config enabled
  - setQueryConfigEnabled
```
public void setQueryConfigEnabled(Boolean queryConfigEnabled)
```
    Sets query config enabled.
    
    Parameters:
    
    queryConfigEnabled - the query config enabled
  - getTryItOutEnabled
```
public Boolean getTryItOutEnabled()
```
    Gets try it out enabled
    
    Returns:
    
    try it out enabled
  - setTryItOutEnabled
```
public void setTryItOutEnabled(Boolean tryItOutEnabled)
```
    Sets try it out enabled
    
    Parameters:
    
    tryItOutEnabled - try it out enabled
  - getPersistAuthorization
```
public Boolean getPersistAuthorization()
```
    Gets persist authorization.
    
    Returns:
    
    the persist authorization
  - setPersistAuthorization
```
public void setPersistAuthorization(Boolean persistAuthorization)
```
    Sets persist authorization.
    
    Parameters:
    
    persistAuthorization - the persist authorization
  - getUrls
```
public Set<AbstractSwaggerUiConfigProperties.SwaggerUrl> getUrls()
```
    Gets urls.
    
    Returns:
    
    the urls
  - setUrls
```
public void setUrls(Set<AbstractSwaggerUiConfigProperties.SwaggerUrl> urls)
```
    Sets urls.
    
    Parameters:
    
    urls - the urls
  - getValidatorUrl
```
public String getValidatorUrl()
```
    Gets validator url.
    
    Returns:
    
    the validator url
  - setValidatorUrl
```
public void setValidatorUrl(String validatorUrl)
```
    Sets validator url.
    
    Parameters:
    
    validatorUrl - the validator url
  - getPath
```
public String getPath()
```
    Gets path.
    
    Returns:
    
    the path
  - setPath
```
public void setPath(String path)
```
    Sets path.
    
    Parameters:
    
    path - the path
  - getLayout
```
public String getLayout()
```
    Gets layout.
    
    Returns:
    
    the layout
  - setLayout
```
public void setLayout(String layout)
```
    Sets layout.
    
    Parameters:
    
    layout - the layout
  - getConfigUrl
```
public String getConfigUrl()
```
    Gets config url.
    
    Returns:
    
    the config url
  - setConfigUrl
```
public void setConfigUrl(String configUrl)
```
    Sets config url.
    
    Parameters:
    
    configUrl - the config url
  - getFilter
```
public String getFilter()
```
    Gets filter.
    
    Returns:
    
    the filter
  - setFilter
```
public void setFilter(String filter)
```
    Sets filter.
    
    Parameters:
    
    filter - the filter
  - getOperationsSorter
```
public String getOperationsSorter()
```
    Gets operations sorter.
    
    Returns:
    
    the operations sorter
  - setOperationsSorter
```
public void setOperationsSorter(String operationsSorter)
```
    Sets operations sorter.
    
    Parameters:
    
    operationsSorter - the operations sorter
  - getTagsSorter
```
public String getTagsSorter()
```
    Gets tags sorter.
    
    Returns:
    
    the tags sorter
  - setTagsSorter
```
public void setTagsSorter(String tagsSorter)
```
    Sets tags sorter.
    
    Parameters:
    
    tagsSorter - the tags sorter
  - getDeepLinking
```
public Boolean getDeepLinking()
```
    Gets deep linking.
    
    Returns:
    
    the deep linking
  - setDeepLinking
```
public void setDeepLinking(Boolean deepLinking)
```
    Sets deep linking.
    
    Parameters:
    
    deepLinking - the deep linking
  - getDisplayOperationId
```
public Boolean getDisplayOperationId()
```
    Gets display operation id.
    
    Returns:
    
    the display operation id
  - setDisplayOperationId
```
public void setDisplayOperationId(Boolean displayOperationId)
```
    Sets display operation id.
    
    Parameters:
    
    displayOperationId - the display operation id
  - getDefaultModelsExpandDepth
```
public Integer getDefaultModelsExpandDepth()
```
    Gets default models expand depth.
    
    Returns:
    
    the default models expand depth
  - setDefaultModelsExpandDepth
```
public void setDefaultModelsExpandDepth(Integer defaultModelsExpandDepth)
```
    Sets default models expand depth.
    
    Parameters:
    
    defaultModelsExpandDepth - the default models expand depth
  - getDefaultModelExpandDepth
```
public Integer getDefaultModelExpandDepth()
```
    Gets default model expand depth.
    
    Returns:
    
    the default model expand depth
  - setDefaultModelExpandDepth
```
public void setDefaultModelExpandDepth(Integer defaultModelExpandDepth)
```
    Sets default model expand depth.
    
    Parameters:
    
    defaultModelExpandDepth - the default model expand depth
  - getDefaultModelRendering
```
public String getDefaultModelRendering()
```
    Gets default model rendering.
    
    Returns:
    
    the default model rendering
  - setDefaultModelRendering
```
public void setDefaultModelRendering(String defaultModelRendering)
```
    Sets default model rendering.
    
    Parameters:
    
    defaultModelRendering - the default model rendering
  - getDisplayRequestDuration
```
public Boolean getDisplayRequestDuration()
```
    Gets display request duration.
    
    Returns:
    
    the display request duration
  - setDisplayRequestDuration
```
public void setDisplayRequestDuration(Boolean displayRequestDuration)
```
    Sets display request duration.
    
    Parameters:
    
    displayRequestDuration - the display request duration
  - getDocExpansion
```
public String getDocExpansion()
```
    Gets doc expansion.
    
    Returns:
    
    the doc expansion
  - setDocExpansion
```
public void setDocExpansion(String docExpansion)
```
    Sets doc expansion.
    
    Parameters:
    
    docExpansion - the doc expansion
  - getMaxDisplayedTags
```
public Integer getMaxDisplayedTags()
```
    Gets max displayed tags.
    
    Returns:
    
    the max displayed tags
  - setMaxDisplayedTags
```
public void setMaxDisplayedTags(Integer maxDisplayedTags)
```
    Sets max displayed tags.
    
    Parameters:
    
    maxDisplayedTags - the max displayed tags
  - getShowExtensions
```
public Boolean getShowExtensions()
```
    Gets show extensions.
    
    Returns:
    
    the show extensions
  - setShowExtensions
```
public void setShowExtensions(Boolean showExtensions)
```
    Sets show extensions.
    
    Parameters:
    
    showExtensions - the show extensions
  - getShowCommonExtensions
```
public Boolean getShowCommonExtensions()
```
    Gets show common extensions.
    
    Returns:
    
    the show common extensions
  - setShowCommonExtensions
```
public void setShowCommonExtensions(Boolean showCommonExtensions)
```
    Sets show common extensions.
    
    Parameters:
    
    showCommonExtensions - the show common extensions
  - getSupportedSubmitMethods
```
public List<String> getSupportedSubmitMethods()
```
    Gets supported submit methods.
    
    Returns:
    
    the supported submit methods
  - setSupportedSubmitMethods
```
public void setSupportedSubmitMethods(List<String> supportedSubmitMethods)
```
    Sets supported submit methods.
    
    Parameters:
    
    supportedSubmitMethods - the supported submit methods
  - getOauth2RedirectUrl
```
public String getOauth2RedirectUrl()
```
    Gets oauth 2 redirect url.
    
    Returns:
    
    the oauth 2 redirect url
  - setOauth2RedirectUrl
```
public void setOauth2RedirectUrl(String oauth2RedirectUrl)
```
    Sets oauth 2 redirect url.
    
    Parameters:
    
    oauth2RedirectUrl - the oauth 2 redirect url
  - getUrl
```
public String getUrl()
```
    Gets url.
    
    Returns:
    
    the url
  - setUrl
```
public void setUrl(String url)
```
    Sets url.
    
    Parameters:
    
    url - the url
  - getGroupsOrder
```
public org.springdoc.core.AbstractSwaggerUiConfigProperties.Direction getGroupsOrder()
```
    Gets groups order.
    
    Returns:
    
    the groups order
  - setGroupsOrder
```
public void setGroupsOrder(org.springdoc.core.AbstractSwaggerUiConfigProperties.Direction groupsOrder)
```
    Sets groups order.
    
    Parameters:
    
    groupsOrder - the groups order
  - getUrlsPrimaryName
```
public String getUrlsPrimaryName()
```
    Gets urls primary name.
    
    Returns:
    
    the urls primary name
  - setUrlsPrimaryName
```
public void setUrlsPrimaryName(String urlsPrimaryName)
```
    Sets urls primary name.
    
    Parameters:
    
    urlsPrimaryName - the urls primary name

Class AbstractSwaggerUiConfigProperties

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

path

layout

configUrl

validatorUrl

filter

operationsSorter

tagsSorter

deepLinking

displayOperationId

defaultModelsExpandDepth

defaultModelExpandDepth

defaultModelRendering

displayRequestDuration

docExpansion

maxDisplayedTags

showExtensions

showCommonExtensions

supportedSubmitMethods

oauth2RedirectUrl

url

urls

groupsOrder

urlsPrimaryName

tryItOutEnabled

persistAuthorization

queryConfigEnabled

withCredentials

Constructor Detail

AbstractSwaggerUiConfigProperties

Method Detail

getWithCredentials

setWithCredentials

getQueryConfigEnabled

setQueryConfigEnabled

getTryItOutEnabled

setTryItOutEnabled

getPersistAuthorization

setPersistAuthorization

getUrls

setUrls

getValidatorUrl

setValidatorUrl

getPath

setPath

getLayout

setLayout

getConfigUrl

setConfigUrl

getFilter

setFilter

getOperationsSorter

setOperationsSorter

getTagsSorter

setTagsSorter

getDeepLinking

setDeepLinking

getDisplayOperationId

setDisplayOperationId

getDefaultModelsExpandDepth

setDefaultModelsExpandDepth

getDefaultModelExpandDepth

setDefaultModelExpandDepth

getDefaultModelRendering

setDefaultModelRendering

getDisplayRequestDuration

setDisplayRequestDuration

getDocExpansion

setDocExpansion

getMaxDisplayedTags

setMaxDisplayedTags

getShowExtensions

setShowExtensions

getShowCommonExtensions