Constant Field Values

Contents

• org.springdoc.*

org.springdoc.*

org.springdoc.core.configuration.SpringDocUIConfiguration

Modifier and Type	Constant Field	Value
public static final String	SPRINGDOC_CONFIG_PROPERTIES	"springdoc.config.properties"

org.springdoc.core.properties.SwaggerUiConfigParameters

Modifier and Type	Constant Field	Value
public static final String	CONFIG_URL_PROPERTY	"configUrl"
public static final String	DEEP_LINKING_PROPERTY	"deepLinking"
public static final String	DISPLAY_OPERATION_ID_PROPERTY	"displayOperationId"
public static final String	DISPLAY_REQUEST_DURATION_PROPERTY	"displayRequestDuration"
public static final String	FILTER_PROPERTY	"filter"
public static final String	LAYOUT_PROPERTY	"layout"
public static final String	OAUTH2_REDIRECT_URL_PROPERTY	"oauth2RedirectUrl"
public static final String	PERSIST_AUTHORIZATION_PROPERTY	"persistAuthorization"
public static final String	QUERY_CONFIG_ENABLED_PROPERTY	"queryConfigEnabled"
public static final String	SHOW_COMMON_EXTENSIONS_PROPERTY	"showCommonExtensions"
public static final String	SHOW_EXTENSIONS_PROPERTY	"showExtensions"
public static final String	TRY_IT_ENABLED_PROPERTY	"tryItOutEnabled"
public static final String	URL_PROPERTY	"url"
public static final String	URLS_PROPERTY	"urls"
public static final String	VALIDATOR_URL_PROPERTY	"validatorUrl"
public static final String	WITH_CREDENTIALS_PROPERTY	"withCredentials"

org.springdoc.core.providers.SpringRepositoryRestResourceProvider

Modifier and Type	Constant Field	Value
public static final String	REPOSITORY_SCHEMA_CONTROLLER	"org.springframework.data.rest.webmvc.RepositorySchemaController"

org.springdoc.core.utils.Constants

Modifier and Type	Constant Field	Value
public static final String	ACTUATOR_DEFAULT_GROUP	"x-actuator"
public static final String	ALL_PATTERN	"/**"
public static final String	API_DOCS_URL	"${springdoc.api-docs.path:#{T(org.springdoc.core.utils.Constants).DEFAULT_API_DOCS_URL}}"
public static final String	APPLICATION_OPENAPI_YAML	"application/vnd.oai.openapi"
public static final String	CLASSPATH_RESOURCE_LOCATION	"classpath:/META-INF/resources"
public static final String	CSRF_DEFAULT_COOKIE_NAME	"XSRF-TOKEN"
public static final String	CSRF_DEFAULT_HEADER_NAME	"X-XSRF-TOKEN"
public static final String	CSRF_DEFAULT_LOCAL_STORAGE_KEY	"XSRF-TOKEN"
public static final String	DEFAULT_API_DOCS_ACTUATOR_URL	"openapi"
public static final String	DEFAULT_API_DOCS_URL	"/v3/api-docs"
public static final String	DEFAULT_API_DOCS_URL_YAML	"${springdoc.api-docs.path:#{T(org.springdoc.core.utils.Constants).DEFAULT_API_DOCS_URL}}.yaml"
public static final String	DEFAULT_DESCRIPTION	"default response"
public static final String	DEFAULT_GROUP_NAME	"springdocDefault"
public static final String	DEFAULT_SERVER_DESCRIPTION	"Generated server url"
public static final String	DEFAULT_SWAGGER_UI_ACTUATOR_PATH	"swagger-ui"
public static final String	DEFAULT_SWAGGER_UI_PATH	"/swagger-ui.html"
public static final String	DEFAULT_TITLE	"OpenAPI definition"
public static final String	DEFAULT_VERSION	"v0"
public static final String	DEFAULT_WEB_JARS_PREFIX_URL	"/webjars"
public static final String	DEFAULT_YAML_API_DOCS_ACTUATOR_PATH	"/yaml"
public static final String	DELETE_METHOD	"delete"
public static final String	DOT	"."
public static final String	GET_METHOD	"get"
public static final String	GRACEFUL_EXCEPTION_OCCURRED	"Graceful exception occurred"
public static final String	GROUP_CONFIG_FIRST_PROPERTY	"springdoc.group-configs[0].group"
public static final String	GROUP_NAME_NOT_NULL_OR_EMPTY	"Group name can not be null or empty"
public static final String	HEAD_METHOD	"head"
public static final String	HEALTH_PATTERN	"/health/*"
public static final String	INDEX_PAGE	"/index.html"
public static final String	LINKS_SCHEMA_CUSTOMISER	"linksSchemaCustomizer"
public static final String	MANAGEMENT_ENDPOINTS_WEB	"management.endpoints.web"
public static final String	MVC_SERVLET_PATH	"${spring.mvc.servlet.path:#{null}}"
public static final String	NULL	":#{null}"
public static final String	OAUTH_REDIRECT_PAGE	"/oauth2-redirect.html"
public static final String	OPENAPI_ARRAY_TYPE	"array"
public static final String	OPENAPI_STRING_TYPE	"string"
public static final String	OPTIONS_METHOD	"options"
public static final String	PATCH_METHOD	"patch"
public static final String	POST_METHOD	"post"
public static final String	PUT_METHOD	"put"
public static final String	QUERY_PARAM	"query"
public static final String	SPRING_MVC_SERVLET_PATH	"spring.mvc.servlet.path"
public static final String	SPRINGDOC_ACTUATOR_DESCRIPTION	"Monitor and interact"
public static final String	SPRINGDOC_ACTUATOR_DOC_DESCRIPTION	"Spring Boot Actuator Web API Documentation"
public static final String	SPRINGDOC_ACTUATOR_DOC_URL	"https://docs.spring.io/spring-boot/docs/current/actuator-api/html/"
public static final String	SPRINGDOC_ACTUATOR_TAG	"Actuator"
public static final String	SPRINGDOC_CACHE_DISABLED	"springdoc.cache.disabled"
public static final String	SPRINGDOC_DEPRECATING_CONVERTER_ENABLED	"springdoc.model-converters.deprecating-converter.enabled"
public static final String	SPRINGDOC_ENABLE_DEFAULT_API_DOCS	"springdoc.enable-default-api-docs"
public static final String	SPRINGDOC_ENABLED	"springdoc.api-docs.enabled"
public static final String	SPRINGDOC_NULLABLE_REQUEST_PARAMETER_ENABLED	"springdoc.nullable-request-parameter-enabled"
public static final String	SPRINGDOC_PAGEABLE_CONVERTER_ENABLED	"springdoc.model-converters.pageable-converter.enabled"
public static final String	SPRINGDOC_POLYMORPHIC_CONVERTER_ENABLED	"springdoc.model-converters.polymorphic-converter.enabled"
public static final String	SPRINGDOC_PREFIX	"springdoc"
public static final String	SPRINGDOC_SCHEMA_RESOLVE_PROPERTIES	"springdoc.api-docs.resolve-schema-properties"
public static final String	SPRINGDOC_SHOW_ACTUATOR	"springdoc.show-actuator"
public static final String	SPRINGDOC_SHOW_LOGIN_ENDPOINT	"springdoc.show-login-endpoint"
public static final String	SPRINGDOC_SHOW_OAUTH2_ENDPOINTS	"springdoc.show-oauth2-endpoints"
public static final String	SPRINGDOC_SHOW_SPRING_CLOUD_FUNCTIONS	"springdoc.show-spring-cloud-functions"
public static final String	SPRINGDOC_SORT_CONVERTER_ENABLED	"springdoc.sort-converter.enabled"
public static final String	SPRINGDOC_SWAGGER_UI_ENABLED	"springdoc.swagger-ui.enabled"
public static final String	SPRINGDOC_USE_MANAGEMENT_PORT	"springdoc.use-management-port"
public static final String	SPRINGDOC_USE_ROOT_PATH	"springdoc.swagger-ui.use-root-path"
public static final String	SWAGGER_CONFIG_FILE	"swagger-config"
public static final String	SWAGGER_CONFIG_URL	"${springdoc.api-docs.path:#{T(org.springdoc.core.utils.Constants).DEFAULT_API_DOCS_URL}}/swagger-config"
public static final String	SWAGGER_INITIALIZER_JS	"swagger-initializer.js"
public static final String	SWAGGER_INITIALIZER_URL	"/swagger-ui/swagger-initializer.js"
public static final String	SWAGGER_UI_DEFAULT_URL	"https://petstore.swagger.io/v2/swagger.json"
public static final String	SWAGGER_UI_OAUTH_REDIRECT_URL	"/swagger-ui/oauth2-redirect.html"
public static final String	SWAGGER_UI_PATH	"${springdoc.swagger-ui.path:#{T(org.springdoc.core.utils.Constants).DEFAULT_SWAGGER_UI_PATH}}"
public static final String	SWAGGER_UI_PREFIX	"/swagger-ui"
public static final String	SWAGGER_UI_URL	"/swagger-ui/index.html"
public static final String	TRACE_METHOD	"trace"
public static final String	YAML	"yaml"