Package org.springdoc.core.properties
Class SwaggerUiConfigParameters
java.lang.Object
org.springdoc.core.properties.AbstractSwaggerUiConfigProperties
org.springdoc.core.properties.SwaggerUiConfigParameters
@Lazy(false)
@Configuration(proxyBeanMethods=false)
@ConditionalOnProperty(name="springdoc.swagger-ui.enabled",
matchIfMissing=true)
@ConditionalOnBean(SpringDocConfiguration.class)
public class SwaggerUiConfigParameters
extends AbstractSwaggerUiConfigProperties
The type Swagger ui config parameters.
- Author:
- bnasslahsen
-
Nested Class Summary
Nested classes/interfaces inherited from class org.springdoc.core.properties.AbstractSwaggerUiConfigProperties
AbstractSwaggerUiConfigProperties.SwaggerUrl
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The constant CONFIG_URL_PROPERTY.static final String
The constant DEEP_LINKING.static final String
The constant DISPLAY_OPERATION_ID.static final String
The constant DISPLAY_REQUEST_DURATION.static final String
The constant FILTER_PROPERTY.static final String
The constant LAYOUT_PROPERTY.static final String
The constant OAUTH2_REDIRECT_URL_PROPERTY.static final String
The constant PERSIST_AUTHORIZATION_PROPERTY.static final String
The constant QUERY_CONFIG_ENABLED_PROPERTY.static final String
The constant SHOW_COMMON_EXTENSIONS_PROPERTY.static final String
The constant SHOW_EXTENSIONS_PROPERTY.static final String
The constant TRY_IT_ENABLED_PROPERTY.static final String
The constant URL_PROPERTY.static final String
The constant URLS_PROPERTY.static final String
The constant VALIDATOR_URL_PROPERTY.static final String
The constant WITH_CREDENTIALS_PROPERTY.Fields inherited from class org.springdoc.core.properties.AbstractSwaggerUiConfigProperties
configUrl, deepLinking, defaultModelExpandDepth, defaultModelRendering, defaultModelsExpandDepth, displayOperationId, displayRequestDuration, docExpansion, filter, groupsOrder, layout, maxDisplayedTags, oauth2RedirectUrl, operationsSorter, path, persistAuthorization, queryConfigEnabled, showCommonExtensions, showExtensions, supportedSubmitMethods, tagsSorter, tryItOutEnabled, url, urls, urlsPrimaryName, validatorUrl, withCredentials
-
Constructor Summary
ConstructorDescriptionSwaggerUiConfigParameters
(SwaggerUiConfigProperties swaggerUiConfig) Instantiates a new Swagger ui config parameters. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Add group.void
Add group.void
Add url.Gets config parameters.Gets ui root path.boolean
isValidUrl
(String url) Is valid url boolean.void
setUiRootPath
(String uiRootPath) Sets ui root path.Methods inherited from class org.springdoc.core.properties.AbstractSwaggerUiConfigProperties
getConfigUrl, getDeepLinking, getDefaultModelExpandDepth, getDefaultModelRendering, getDefaultModelsExpandDepth, getDisplayOperationId, getDisplayRequestDuration, getDocExpansion, getFilter, getGroupsOrder, getLayout, getMaxDisplayedTags, getOauth2RedirectUrl, getOperationsSorter, getPath, getPersistAuthorization, getQueryConfigEnabled, getShowCommonExtensions, getShowExtensions, getSupportedSubmitMethods, getTagsSorter, getTryItOutEnabled, getUrl, getUrls, getUrlsPrimaryName, getValidatorUrl, getWithCredentials, setConfigUrl, setDeepLinking, setDefaultModelExpandDepth, setDefaultModelRendering, setDefaultModelsExpandDepth, setDisplayOperationId, setDisplayRequestDuration, setDocExpansion, setFilter, setGroupsOrder, setLayout, setMaxDisplayedTags, setOauth2RedirectUrl, setOperationsSorter, setPath, setPersistAuthorization, setQueryConfigEnabled, setShowCommonExtensions, setShowExtensions, setSupportedSubmitMethods, setTagsSorter, setTryItOutEnabled, setUrl, setUrls, setUrlsPrimaryName, setValidatorUrl, setWithCredentials
-
Field Details
-
CONFIG_URL_PROPERTY
The constant CONFIG_URL_PROPERTY.- See Also:
-
LAYOUT_PROPERTY
The constant LAYOUT_PROPERTY.- See Also:
-
FILTER_PROPERTY
The constant FILTER_PROPERTY.- See Also:
-
URL_PROPERTY
The constant URL_PROPERTY.- See Also:
-
URLS_PROPERTY
The constant URLS_PROPERTY.- See Also:
-
OAUTH2_REDIRECT_URL_PROPERTY
The constant OAUTH2_REDIRECT_URL_PROPERTY.- See Also:
-
VALIDATOR_URL_PROPERTY
The constant VALIDATOR_URL_PROPERTY.- See Also:
-
QUERY_CONFIG_ENABLED_PROPERTY
The constant QUERY_CONFIG_ENABLED_PROPERTY.- See Also:
-
DISPLAY_OPERATION_ID_PROPERTY
The constant DISPLAY_OPERATION_ID.- See Also:
-
DEEP_LINKING_PROPERTY
The constant DEEP_LINKING.- See Also:
-
DISPLAY_REQUEST_DURATION_PROPERTY
The constant DISPLAY_REQUEST_DURATION.- See Also:
-
SHOW_EXTENSIONS_PROPERTY
The constant SHOW_EXTENSIONS_PROPERTY.- See Also:
-
SHOW_COMMON_EXTENSIONS_PROPERTY
The constant SHOW_COMMON_EXTENSIONS_PROPERTY.- See Also:
-
TRY_IT_ENABLED_PROPERTY
The constant TRY_IT_ENABLED_PROPERTY.- See Also:
-
PERSIST_AUTHORIZATION_PROPERTY
The constant PERSIST_AUTHORIZATION_PROPERTY.- See Also:
-
WITH_CREDENTIALS_PROPERTY
The constant WITH_CREDENTIALS_PROPERTY.- See Also:
-
-
Constructor Details
-
SwaggerUiConfigParameters
Instantiates a new Swagger ui config parameters.- Parameters:
swaggerUiConfig
- the swagger ui config
-
-
Method Details
-
addGroup
Add group.- Parameters:
group
- the groupdisplayName
- the display name
-
addGroup
Add group.- Parameters:
group
- the group
-
addUrl
Add url.- Parameters:
url
- the url
-
getUiRootPath
Gets ui root path.- Returns:
- the ui root path
-
setUiRootPath
Sets ui root path.- Parameters:
uiRootPath
- the ui root path
-
isValidUrl
Is valid url boolean.- Parameters:
url
- the url- Returns:
- the boolean
-
getConfigParameters
Gets config parameters.- Returns:
- the config parameters
-