Skip navigation links
A B C D E F G H I L M N O P Q R S T U V W 

A

AbstractOpenApiResource - Class in org.springdoc.api
 
AbstractOpenApiResource(String, OpenAPIBuilder, AbstractRequestBuilder, GenericResponseBuilder, OperationBuilder, Optional<List<OpenApiCustomiser>>, SpringDocConfigProperties) - Constructor for class org.springdoc.api.AbstractOpenApiResource
 
AbstractRequestBuilder - Class in org.springdoc.core
 
AbstractRequestBuilder(GenericParameterBuilder, RequestBodyBuilder, OperationBuilder, Optional<List<OperationCustomizer>>, Optional<List<ParameterCustomizer>>, LocalVariableTableParameterNameDiscoverer) - Constructor for class org.springdoc.core.AbstractRequestBuilder
 
AbstractSwaggerIndexTransformer - Class in org.springdoc.ui
 
AbstractSwaggerIndexTransformer(SwaggerUiOAuthProperties, ObjectMapper) - Constructor for class org.springdoc.ui.AbstractSwaggerIndexTransformer
 
AbstractSwaggerWelcome - Class in org.springdoc.ui
 
AbstractSwaggerWelcome(SwaggerUiConfigProperties, SpringDocConfigProperties) - Constructor for class org.springdoc.ui.AbstractSwaggerWelcome
 
addAnnotationsToIgnore(Class<?>...) - Static method in class org.springdoc.core.GenericParameterBuilder
 
addAnnotationsToIgnore(Class<?>...) - Method in class org.springdoc.core.SpringDocUtils
 
addDeprecatedType(Class<?>) - Static method in class org.springdoc.api.AbstractOpenApiResource
 
addDeprecatedType(Class<?>) - Method in class org.springdoc.core.SpringDocUtils
 
addFileType(Class<?>...) - Static method in class org.springdoc.core.GenericParameterBuilder
 
addFileType(Class<?>...) - Method in class org.springdoc.core.SpringDocUtils
 
addGroup(String) - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
addGroupConfig(SpringDocConfigProperties.GroupConfig) - Method in class org.springdoc.core.SpringDocConfigProperties
 
addHiddenRestControllers(Class<?>...) - Static method in class org.springdoc.api.AbstractOpenApiResource
 
addHiddenRestControllers(Class<?>...) - Method in class org.springdoc.core.SpringDocUtils
 
addInitOauth(String) - Method in class org.springdoc.ui.AbstractSwaggerIndexTransformer
 
AdditionalModelsConverter - Class in org.springdoc.core.converters
 
AdditionalModelsConverter() - Constructor for class org.springdoc.core.converters.AdditionalModelsConverter
 
addMappings(Map<String, Object>) - Method in class org.springdoc.core.OpenAPIBuilder
 
addOpenApiCustomiser(OpenApiCustomiser) - Method in class org.springdoc.core.GroupedOpenApi.Builder
 
addRequestWrapperToIgnore(Class<?>...) - Static method in class org.springdoc.core.AbstractRequestBuilder
 
addRequestWrapperToIgnore(Class<?>...) - Method in class org.springdoc.core.SpringDocUtils
 
addResponseTypeToIgnore(Class<?>) - Static method in class org.springdoc.core.converters.ConverterUtils
 
addResponseTypeToIgnore(Class<?>) - Method in class org.springdoc.core.SpringDocUtils
 
addResponseWrapperToIgnore(Class<?>) - Static method in class org.springdoc.core.converters.ConverterUtils
 
addResponseWrapperToIgnore(Class<?>) - Method in class org.springdoc.core.SpringDocUtils
 
addRestControllers(Class<?>...) - Static method in class org.springdoc.api.AbstractOpenApiResource
 
addRestControllers(Class<?>...) - Method in class org.springdoc.core.SpringDocUtils
 
addTag(Set<HandlerMethod>, Tag) - Method in class org.springdoc.core.OpenAPIBuilder
 
addUrl(String) - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
afterPropertiesSet() - Method in class org.springdoc.ui.AbstractSwaggerWelcome
 
API_DOCS_URL - Static variable in class org.springdoc.core.Constants
 
ApiDocs() - Constructor for class org.springdoc.core.SpringDocConfigProperties.ApiDocs
 
APPLICATION_OPENAPI_YAML - Static variable in class org.springdoc.core.Constants
 

B

build(HandlerMethod, RequestMethod, Operation, MethodAttributes, OpenAPI) - Method in class org.springdoc.core.AbstractRequestBuilder
 
build(Components, HandlerMethod, Operation, MethodAttributes) - Method in class org.springdoc.core.GenericResponseBuilder
 
build() - Method in class org.springdoc.core.GroupedOpenApi.Builder
 
build() - Method in class org.springdoc.core.OpenAPIBuilder
 
buildCallbacks(Set<Callback>, OpenAPI, MethodAttributes) - Method in class org.springdoc.core.OperationBuilder
 
buildConfigUrl(String, UriComponentsBuilder) - Method in class org.springdoc.ui.AbstractSwaggerWelcome
 
builder() - Static method in class org.springdoc.core.GroupedOpenApi
 
buildGenericResponse(Components, Map<String, Object>) - Method in class org.springdoc.core.GenericResponseBuilder
 
buildRequestBodyFromDoc(RequestBody, String[], String[], Components, JsonView) - Method in class org.springdoc.core.RequestBodyBuilder
 
buildTags(HandlerMethod, Operation, OpenAPI) - Method in class org.springdoc.core.OpenAPIBuilder
 
buildUrl(String, String) - Method in class org.springdoc.ui.AbstractSwaggerWelcome
 

C

Cache() - Constructor for class org.springdoc.core.SpringDocConfigProperties.Cache
 
CacheOrGroupedOpenApiCondition - Class in org.springdoc.core
 
calculateCachedOpenAPI() - Method in class org.springdoc.core.OpenAPIBuilder
 
calculateConsumesProduces(Method) - Method in class org.springdoc.core.MethodAttributes
 
calculateOauth2RedirectUrl(UriComponentsBuilder) - Method in class org.springdoc.ui.AbstractSwaggerWelcome
 
calculatePath(HandlerMethod, String, Set<RequestMethod>) - Method in class org.springdoc.api.AbstractOpenApiResource
 
calculateRequestBodyInfo(Components, MethodAttributes, ParameterInfo, RequestBodyInfo) - Method in class org.springdoc.core.RequestBodyBuilder
 
calculateSchema(Components, Type, JsonView) - Method in class org.springdoc.core.GenericResponseBuilder
 
calculateUiRootPath(StringBuilder...) - Method in class org.springdoc.ui.AbstractSwaggerWelcome
 
CLASSPATH_RESOURCE_LOCATION - Static variable in class org.springdoc.core.Constants
 
CONFIG_URL_PROPERTY - Static variable in class org.springdoc.core.SwaggerUiConfigProperties
 
Constants - Class in org.springdoc.core
 
ConverterUtils - Class in org.springdoc.core.converters
 
customise(OpenAPIBuilder) - Method in interface org.springdoc.core.customizers.OpenApiBuilderCustomiser
 
customise(OpenAPI) - Method in interface org.springdoc.core.customizers.OpenApiCustomiser
 
customiseOperation(Operation, HandlerMethod) - Method in class org.springdoc.core.AbstractRequestBuilder
 
customiseParameter(Parameter, ParameterInfo) - Method in class org.springdoc.core.AbstractRequestBuilder
 
customize(Operation, HandlerMethod) - Method in interface org.springdoc.core.customizers.OperationCustomizer
 
customize(Parameter, MethodParameter) - Method in interface org.springdoc.core.customizers.ParameterCustomizer
 
customize(Schema, AnnotatedType) - Method in interface org.springdoc.core.customizers.PropertyCustomizer
 

D

decode(String) - Method in class org.springdoc.api.AbstractOpenApiResource
 
DEFAULT_API_DOCS_URL - Static variable in class org.springdoc.core.Constants
 
DEFAULT_API_DOCS_URL_YAML - Static variable in class org.springdoc.core.Constants
 
DEFAULT_DESCRIPTION - Static variable in class org.springdoc.core.Constants
 
DEFAULT_GROUP_NAME - Static variable in class org.springdoc.core.Constants
 
DEFAULT_SERVER_DESCRIPTION - Static variable in class org.springdoc.core.Constants
 
DEFAULT_SWAGGER_UI_PATH - Static variable in class org.springdoc.core.Constants
 
DEFAULT_TITLE - Static variable in class org.springdoc.core.Constants
 
DEFAULT_VERSION - Static variable in class org.springdoc.core.Constants
 
DEFAULT_WEB_JARS_PREFIX_URL - Static variable in class org.springdoc.core.Constants
 
defaultValue() - Method in class org.springdoc.core.RequestInfo
 
DELETE_METHOD - Static variable in class org.springdoc.core.Constants
 

E

extractSchema(Components, Type, JsonView, Annotation[]) - Static method in class org.springdoc.core.SpringDocAnnotationsUtils
 
extractSchema(Components, Type, JsonView) - Static method in class org.springdoc.core.SpringDocAnnotationsUtils
 

F

FILTER_PROPERTY - Static variable in class org.springdoc.core.SwaggerUiConfigProperties
 

G

GenericParameterBuilder - Class in org.springdoc.core
 
GenericParameterBuilder(PropertyResolverUtils) - Constructor for class org.springdoc.core.GenericParameterBuilder
 
GenericResponseBuilder - Class in org.springdoc.core
 
GenericResponseBuilder(OperationBuilder, List<ReturnTypeParser>, SpringDocConfigProperties, PropertyResolverUtils) - Constructor for class org.springdoc.core.GenericResponseBuilder
 
GET_METHOD - Static variable in class org.springdoc.core.Constants
 
getAdditionalQueryStringParams() - Method in class org.springdoc.core.SwaggerUiOAuthProperties
 
getApiDocs() - Method in class org.springdoc.core.SpringDocConfigProperties
 
getAppName() - Method in class org.springdoc.core.SwaggerUiOAuthProperties
 
getCachedOpenAPI() - Method in class org.springdoc.core.OpenAPIBuilder
 
getCalculatedOpenAPI() - Method in class org.springdoc.core.OpenAPIBuilder
 
getClassConsumes() - Method in class org.springdoc.core.MethodAttributes
 
getClassProduces() - Method in class org.springdoc.core.MethodAttributes
 
getClientId() - Method in class org.springdoc.core.SwaggerUiOAuthProperties
 
getClientSecret() - Method in class org.springdoc.core.SwaggerUiOAuthProperties
 
getConfig() - Static method in class org.springdoc.core.SpringDocUtils
 
getConfigParameters() - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
getConfigParameters() - Method in class org.springdoc.core.SwaggerUiOAuthProperties
 
getConfigUrl() - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
getContent(Content[], String[], String[], Schema, Components, JsonView) - Static method in class org.springdoc.core.SpringDocAnnotationsUtils
 
getControllerAdviceMap() - Method in class org.springdoc.core.OpenAPIBuilder
 
getDeepLinking() - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
getDefaultAllowedHttpMethods() - Method in class org.springdoc.api.AbstractOpenApiResource
 
getDefaultConsumesMediaType() - Method in class org.springdoc.core.SpringDocConfigProperties
 
getDefaultModelExpandDepth() - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
getDefaultModelRendering() - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
getDefaultModelsExpandDepth() - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
getDefaultProducesMediaType() - Method in class org.springdoc.core.SpringDocConfigProperties
 
getDisplayOperationId() - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
getDisplayRequestDuration() - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
getDocExpansion() - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
getFilter() - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
getFrameworkEndpoints() - Method in interface org.springdoc.core.SecurityOAuth2Provider
 
getGroup() - Method in class org.springdoc.core.GroupedOpenApi
 
getGroup() - Method in class org.springdoc.core.SpringDocConfigProperties.GroupConfig
 
getGroupConfigs() - Method in class org.springdoc.core.SpringDocConfigProperties
 
getGroups() - Method in class org.springdoc.core.SpringDocConfigProperties.ApiDocs
 
getGroupsOrder() - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
getHandlerMethods() - Method in interface org.springdoc.core.SecurityOAuth2Provider
 
getHeaders() - Method in class org.springdoc.core.MethodAttributes
 
getJsonViewAnnotation() - Method in class org.springdoc.core.MethodAttributes
 
getJsonViewAnnotationForRequestBody() - Method in class org.springdoc.core.MethodAttributes
 
getLayout() - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
getMappingsMap() - Method in class org.springdoc.core.OpenAPIBuilder
 
getMaxDisplayedTags() - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
getMethodConsumes() - Method in class org.springdoc.core.MethodAttributes
 
getMethodProduces() - Method in class org.springdoc.core.MethodAttributes
 
getOauth2RedirectUrl() - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
getOpenApi() - Method in class org.springdoc.api.AbstractOpenApiResource
 
getOpenApiCustomisers() - Method in class org.springdoc.core.GroupedOpenApi
 
getOperationId(String, String, OpenAPI) - Method in class org.springdoc.core.OperationBuilder
 
getOperationsSorter() - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
getPackagesToExclude() - Method in class org.springdoc.core.GroupedOpenApi
 
getPackagesToExclude() - Method in class org.springdoc.core.SpringDocConfigProperties
 
getPackagesToExclude() - Method in class org.springdoc.core.SpringDocConfigProperties.GroupConfig
 
getPackagesToScan() - Method in class org.springdoc.core.GroupedOpenApi
 
getPackagesToScan() - Method in class org.springdoc.core.SpringDocConfigProperties
 
getPackagesToScan() - Method in class org.springdoc.core.SpringDocConfigProperties.GroupConfig
 
getPath() - Method in class org.springdoc.core.SpringDocConfigProperties.ApiDocs
 
getPath() - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
getPaths(Map<String, Object>) - Method in class org.springdoc.api.AbstractOpenApiResource
 
getPathsToExclude() - Method in class org.springdoc.core.GroupedOpenApi
 
getPathsToExclude() - Method in class org.springdoc.core.SpringDocConfigProperties
 
getPathsToExclude() - Method in class org.springdoc.core.SpringDocConfigProperties.GroupConfig
 
getPathsToMatch() - Method in class org.springdoc.core.GroupedOpenApi
 
getPathsToMatch() - Method in class org.springdoc.core.SpringDocConfigProperties
 
getPathsToMatch() - Method in class org.springdoc.core.SpringDocConfigProperties.GroupConfig
 
getPrefix() - Method in class org.springdoc.core.SpringDocConfigProperties.Webjars
 
getRealm() - Method in class org.springdoc.core.SwaggerUiOAuthProperties
 
getReplacement(Class) - Static method in class org.springdoc.core.converters.AdditionalModelsConverter
 
getRequestBodyBuilder() - Method in class org.springdoc.core.AbstractRequestBuilder
 
getReturnType(MethodParameter) - Method in interface org.springdoc.core.ReturnTypeParser
 
getScopeSeparator() - Method in class org.springdoc.core.SwaggerUiOAuthProperties
 
getShowCommonExtensions() - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
getShowExtensions() - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
getSupportedSubmitMethods() - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
getTagsSorter() - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
getUriComponentsBuilder(String) - Method in class org.springdoc.ui.AbstractSwaggerWelcome
 
getUrl() - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
getUrls() - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
getUseBasicAuthenticationWithAccessCodeGrant() - Method in class org.springdoc.core.SwaggerUiOAuthProperties
 
getUsePkceWithAuthorizationCodeGrant() - Method in class org.springdoc.core.SwaggerUiOAuthProperties
 
getValidatorUrl() - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
getWebjars() - Method in class org.springdoc.core.SpringDocConfigProperties
 
GROUP_CONFIG_FIRST_PROPERTY - Static variable in class org.springdoc.core.Constants
 
GROUP_NAME_NOT_NULL - Static variable in class org.springdoc.core.Constants
 
GroupConfig() - Constructor for class org.springdoc.core.SpringDocConfigProperties.GroupConfig
 
GroupConfig(String, List<String>, List<String>, List<String>, List<String>) - Constructor for class org.springdoc.core.SpringDocConfigProperties.GroupConfig
 
GroupedOpenApi - Class in org.springdoc.core
 
GroupedOpenApi.Builder - Class in org.springdoc.core
 
Groups() - Constructor for class org.springdoc.core.SpringDocConfigProperties.Groups
 

H

HEAD_METHOD - Static variable in class org.springdoc.core.Constants
 

I

isAdditionalRestController(Class<?>) - Method in class org.springdoc.api.AbstractOpenApiResource
 
isAnnotationToIgnore(MethodParameter) - Method in class org.springdoc.core.GenericParameterBuilder
 
isAutoTagClasses() - Method in class org.springdoc.core.SpringDocConfigProperties
 
isCacheDisabled() - Method in class org.springdoc.core.SpringDocConfigProperties
 
isDisabled() - Method in class org.springdoc.core.SpringDocConfigProperties.Cache
 
isEnabled() - Method in class org.springdoc.core.SpringDocConfigProperties.ApiDocs
 
isEnabled() - Method in class org.springdoc.core.SpringDocConfigProperties.Groups
 
isFile(MethodParameter) - Method in class org.springdoc.core.GenericParameterBuilder
 
isHidden(Method) - Method in class org.springdoc.core.OperationBuilder
 
isHiddenRestControllers(Class<?>) - Method in class org.springdoc.api.AbstractOpenApiResource
 
isMethodOverloaded() - Method in class org.springdoc.core.MethodAttributes
 
isModelAndViewAllowed() - Method in class org.springdoc.core.SpringDocConfigProperties
 
isNoApiResponseDoc() - Method in class org.springdoc.core.MethodAttributes
 
isOverrideWithGenericResponse() - Method in class org.springdoc.core.SpringDocConfigProperties
 
isPackageToScan(String) - Method in class org.springdoc.api.AbstractOpenApiResource
 
isParamToIgnore(MethodParameter) - Method in class org.springdoc.core.AbstractRequestBuilder
 
isPathToMatch(String) - Method in class org.springdoc.api.AbstractOpenApiResource
 
isRemoveBrokenReferenceDefinitions() - Method in class org.springdoc.core.SpringDocConfigProperties
 
isRequestTypeToIgnore(Class<?>) - Static method in class org.springdoc.core.AbstractRequestBuilder
 
isResolveSchemaProperties() - Method in class org.springdoc.core.SpringDocConfigProperties.ApiDocs
 
isResponseTypeToIgnore(Class<?>) - Static method in class org.springdoc.core.converters.ConverterUtils
 
isResponseTypeWrapper(Class<?>) - Static method in class org.springdoc.core.converters.ConverterUtils
 
isServersPresent() - Method in class org.springdoc.core.OpenAPIBuilder
 
isShowActuator() - Method in class org.springdoc.core.SpringDocConfigProperties
 
isValidUrl(String) - Method in class org.springdoc.core.SwaggerUiConfigProperties
 

L

LAYOUT_PROPERTY - Static variable in class org.springdoc.core.SwaggerUiConfigProperties
 

M

MethodAttributes - Class in org.springdoc.core
 
MethodAttributes(String[], String, String) - Constructor for class org.springdoc.core.MethodAttributes
 
MethodAttributes(String, String) - Constructor for class org.springdoc.core.MethodAttributes
 
ModelConverterRegistrar - Class in org.springdoc.core.converters
Wrapper for model converters to only register converters once
ModelConverterRegistrar(List<ModelConverter>) - Constructor for class org.springdoc.core.converters.ModelConverterRegistrar
 
MultipleOpenApiSupportCondition - Class in org.springdoc.core
 
MVC_SERVLET_PATH - Static variable in class org.springdoc.core.Constants
 

N

NULL - Static variable in class org.springdoc.core.Constants
 

O

oauth2RedirectUrl - Variable in class org.springdoc.ui.AbstractSwaggerWelcome
 
objectMapper - Variable in class org.springdoc.ui.AbstractSwaggerIndexTransformer
 
OPENAPI_ARRAY_TYPE - Static variable in class org.springdoc.core.Constants
 
OPENAPI_STRING_TYPE - Static variable in class org.springdoc.core.Constants
 
openAPIBuilder - Variable in class org.springdoc.api.AbstractOpenApiResource
 
OpenAPIBuilder - Class in org.springdoc.core
 
OpenApiBuilderCustomiser - Interface in org.springdoc.core.customizers
 
OpenApiCustomiser - Interface in org.springdoc.core.customizers
 
OperationBuilder - Class in org.springdoc.core
 
OperationBuilder(GenericParameterBuilder, RequestBodyBuilder, SecurityParser, PropertyResolverUtils) - Constructor for class org.springdoc.core.OperationBuilder
 
OperationCustomizer - Interface in org.springdoc.core.customizers
Implement and register a bean of type OperationCustomizer to customize an operation based on the handler method input
OPTIONS_METHOD - Static variable in class org.springdoc.core.Constants
 
org.springdoc.api - package org.springdoc.api
 
org.springdoc.api.annotations - package org.springdoc.api.annotations
 
org.springdoc.core - package org.springdoc.core
 
org.springdoc.core.converters - package org.springdoc.core.converters
 
org.springdoc.core.customizers - package org.springdoc.core.customizers
 
org.springdoc.ui - package org.springdoc.ui
 

P

packagesToExclude(String...) - Method in class org.springdoc.core.GroupedOpenApi.Builder
 
packagesToScan(String...) - Method in class org.springdoc.core.GroupedOpenApi.Builder
 
ParameterCustomizer - Interface in org.springdoc.core.customizers
Implement and register a bean of type ParameterCustomizer to customize a parameter based on the parameter and handler method input
ParameterObject - Annotation Type in org.springdoc.api.annotations
 
parse(Operation, Operation, OpenAPI, MethodAttributes) - Method in class org.springdoc.core.OperationBuilder
 
PATCH_METHOD - Static variable in class org.springdoc.core.Constants
 
pathsToExclude(String...) - Method in class org.springdoc.core.GroupedOpenApi.Builder
 
pathsToMatch(String...) - Method in class org.springdoc.core.GroupedOpenApi.Builder
 
POST_METHOD - Static variable in class org.springdoc.core.Constants
 
PropertyCustomizer - Interface in org.springdoc.core.customizers
Implement and register a bean of type PropertyCustomizer to customize a schema property based on annotated type
PropertyCustomizingConverter - Class in org.springdoc.core.converters
 
PropertyCustomizingConverter(Optional<List<PropertyCustomizer>>) - Constructor for class org.springdoc.core.converters.PropertyCustomizingConverter
 
PropertyResolverUtils - Class in org.springdoc.core
 
PropertyResolverUtils(ConfigurableBeanFactory) - Constructor for class org.springdoc.core.PropertyResolverUtils
 
put(String, List<String>, Map<String, Object>) - Static method in interface org.springdoc.core.SpringDocPropertiesUtils
 
put(String, Integer, Map<String, Object>) - Static method in interface org.springdoc.core.SpringDocPropertiesUtils
 
put(String, Boolean, Map<String, Object>) - Static method in interface org.springdoc.core.SpringDocPropertiesUtils
 
put(String, String, Map<String, Object>) - Static method in interface org.springdoc.core.SpringDocPropertiesUtils
 
PUT_METHOD - Static variable in class org.springdoc.core.Constants
 

Q

QUERY_PARAM - Static variable in class org.springdoc.core.Constants
 

R

readFullyAsString(InputStream) - Method in class org.springdoc.ui.AbstractSwaggerIndexTransformer
 
removeAnnotationsToIgnore(Class<?>...) - Static method in class org.springdoc.core.GenericParameterBuilder
 
removeAnnotationsToIgnore(Class<?>...) - Method in class org.springdoc.core.SpringDocUtils
 
removeRequestWrapperToIgnore(Class<?>...) - Static method in class org.springdoc.core.AbstractRequestBuilder
 
removeRequestWrapperToIgnore(Class<?>...) - Method in class org.springdoc.core.SpringDocUtils
 
removeResponseTypeToIgnore(Class<?>) - Static method in class org.springdoc.core.converters.ConverterUtils
 
removeResponseTypeToIgnore(Class<?>) - Method in class org.springdoc.core.SpringDocUtils
 
removeResponseWrapperToIgnore(Class<?>) - Static method in class org.springdoc.core.converters.ConverterUtils
 
removeResponseWrapperToIgnore(Class<?>) - Method in class org.springdoc.core.SpringDocUtils
 
replaceWithClass(Class, Class) - Static method in class org.springdoc.core.converters.AdditionalModelsConverter
 
replaceWithClass(Class, Class) - Method in class org.springdoc.core.SpringDocUtils
 
replaceWithSchema(Class, Schema) - Static method in class org.springdoc.core.converters.AdditionalModelsConverter
 
replaceWithSchema(Class, Schema) - Method in class org.springdoc.core.SpringDocUtils
 
RequestBodyBuilder - Class in org.springdoc.core
 
RequestBodyBuilder(GenericParameterBuilder) - Constructor for class org.springdoc.core.RequestBodyBuilder
 
RequestInfo - Class in org.springdoc.core
 
RequestInfo(String, String, boolean, String) - Constructor for class org.springdoc.core.RequestInfo
 
RequestTypeToIgnoreConverter - Class in org.springdoc.core.converters
 
RequestTypeToIgnoreConverter() - Constructor for class org.springdoc.core.converters.RequestTypeToIgnoreConverter
 
required() - Method in class org.springdoc.core.RequestInfo
 
resetCalculatedOpenAPI() - Method in class org.springdoc.core.OpenAPIBuilder
 
resolve(AnnotatedType, ModelConverterContext, Iterator<ModelConverter>) - Method in class org.springdoc.core.converters.AdditionalModelsConverter
 
resolve(AnnotatedType, ModelConverterContext, Iterator<ModelConverter>) - Method in class org.springdoc.core.converters.PropertyCustomizingConverter
 
resolve(AnnotatedType, ModelConverterContext, Iterator<ModelConverter>) - Method in class org.springdoc.core.converters.RequestTypeToIgnoreConverter
 
resolve(AnnotatedType, ModelConverterContext, Iterator<ModelConverter>) - Method in class org.springdoc.core.converters.ResponseSupportConverter
 
resolve(String) - Method in class org.springdoc.core.PropertyResolverUtils
 
resolveProperties(Schema, PropertyResolverUtils) - Method in class org.springdoc.core.OpenAPIBuilder
 
resolveSchemaFromType(Class<?>, Components, JsonView, Annotation[]) - Static method in class org.springdoc.core.SpringDocAnnotationsUtils
 
resolveType(Type, Class<?>) - Static method in interface org.springdoc.core.ReturnTypeParser
This is a copy of GenericTypeResolver.resolveType which is not available on spring 4.
resolveVariable(TypeVariable<?>, ResolvableType) - Static method in interface org.springdoc.core.ReturnTypeParser
 
ResponseSupportConverter - Class in org.springdoc.core.converters
 
ResponseSupportConverter() - Constructor for class org.springdoc.core.converters.ResponseSupportConverter
 
ReturnTypeParser - Interface in org.springdoc.core
 

S

SecurityOAuth2Provider - Interface in org.springdoc.core
 
setAdditionalQueryStringParams(List<String>) - Method in class org.springdoc.core.SwaggerUiOAuthProperties
 
setApiDocs(SpringDocConfigProperties.ApiDocs) - Method in class org.springdoc.core.SpringDocConfigProperties
 
setAppName(String) - Method in class org.springdoc.core.SwaggerUiOAuthProperties
 
setAutoTagClasses(boolean) - Method in class org.springdoc.core.SpringDocConfigProperties
 
setCache(SpringDocConfigProperties.Cache) - Method in class org.springdoc.core.SpringDocConfigProperties
 
setCachedOpenAPI(OpenAPI) - Method in class org.springdoc.core.OpenAPIBuilder
 
setClassConsumes(String[]) - Method in class org.springdoc.core.MethodAttributes
 
setClassProduces(String[]) - Method in class org.springdoc.core.MethodAttributes
 
setClientId(String) - Method in class org.springdoc.core.SwaggerUiOAuthProperties
 
setClientSecret(String) - Method in class org.springdoc.core.SwaggerUiOAuthProperties
 
setConfigUrl(String) - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
setDeepLinking(Boolean) - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
setDefaultConsumesMediaType(String) - Method in class org.springdoc.core.SpringDocConfigProperties
 
setDefaultModelExpandDepth(Integer) - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
setDefaultModelRendering(String) - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
setDefaultModelsExpandDepth(Integer) - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
setDefaultProducesMediaType(String) - Method in class org.springdoc.core.SpringDocConfigProperties
 
setDisabled(boolean) - Method in class org.springdoc.core.SpringDocConfigProperties.Cache
 
setDisplayOperationId(Boolean) - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
setDisplayRequestDuration(Boolean) - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
setDocExpansion(String) - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
setEnabled(boolean) - Method in class org.springdoc.core.SpringDocConfigProperties.ApiDocs
 
setEnabled(boolean) - Method in class org.springdoc.core.SpringDocConfigProperties.Groups
 
setFilter(String) - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
setGroup(String) - Method in class org.springdoc.core.GroupedOpenApi.Builder
 
setGroup(String) - Method in class org.springdoc.core.SpringDocConfigProperties.GroupConfig
 
setGroupConfigs(List<SpringDocConfigProperties.GroupConfig>) - Method in class org.springdoc.core.SpringDocConfigProperties
 
setGroups(SpringDocConfigProperties.Groups) - Method in class org.springdoc.core.SpringDocConfigProperties.ApiDocs
 
setGroupsOrder(SwaggerUiConfigProperties.Direction) - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
setJsonViewAnnotation(JsonView) - Method in class org.springdoc.core.MethodAttributes
 
setJsonViewAnnotationForRequestBody(JsonView) - Method in class org.springdoc.core.MethodAttributes
 
setLayout(String) - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
setMaxDisplayedTags(Integer) - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
setMethodOverloaded(boolean) - Method in class org.springdoc.core.MethodAttributes
 
setModelAndViewAllowed(boolean) - Method in class org.springdoc.core.SpringDocConfigProperties
 
setOauth2RedirectUrl(String) - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
setOperationsSorter(String) - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
setOverrideWithGenericResponse(boolean) - Method in class org.springdoc.core.SpringDocConfigProperties
 
setPackagesToExclude(List<String>) - Method in class org.springdoc.core.SpringDocConfigProperties.GroupConfig
 
setPackagesToExclude(List<String>) - Method in class org.springdoc.core.SpringDocConfigProperties
 
setPackagesToScan(List<String>) - Method in class org.springdoc.core.SpringDocConfigProperties.GroupConfig
 
setPackagesToScan(List<String>) - Method in class org.springdoc.core.SpringDocConfigProperties
 
setPath(String) - Method in class org.springdoc.core.SpringDocConfigProperties.ApiDocs
 
setPath(String) - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
setPathsToExclude(List<String>) - Method in class org.springdoc.core.SpringDocConfigProperties.GroupConfig
 
setPathsToExclude(List<String>) - Method in class org.springdoc.core.SpringDocConfigProperties
 
setPathsToMatch(List<String>) - Method in class org.springdoc.core.SpringDocConfigProperties.GroupConfig
 
setPathsToMatch(List<String>) - Method in class org.springdoc.core.SpringDocConfigProperties
 
setPrefix(String) - Method in class org.springdoc.core.SpringDocConfigProperties.Webjars
 
setRealm(String) - Method in class org.springdoc.core.SwaggerUiOAuthProperties
 
setRemoveBrokenReferenceDefinitions(boolean) - Method in class org.springdoc.core.SpringDocConfigProperties
 
setResolveSchemaProperties(boolean) - Method in class org.springdoc.core.SpringDocConfigProperties.ApiDocs
 
setScopeSeparator(String) - Method in class org.springdoc.core.SwaggerUiOAuthProperties
 
setServerBaseUrl(String) - Method in class org.springdoc.core.OpenAPIBuilder
 
setShowActuator(boolean) - Method in class org.springdoc.core.SpringDocConfigProperties
 
setShowCommonExtensions(Boolean) - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
setShowExtensions(Boolean) - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
setSupportedSubmitMethods(List<String>) - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
setTagsSorter(String) - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
setUrl(String) - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
setUrls(Set<SwaggerUiConfigProperties.SwaggerUrl>) - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
setUseBasicAuthenticationWithAccessCodeGrant(String) - Method in class org.springdoc.core.SwaggerUiOAuthProperties
 
setUsePkceWithAuthorizationCodeGrant(Boolean) - Method in class org.springdoc.core.SwaggerUiOAuthProperties
 
setValidatorUrl(String) - Method in class org.springdoc.core.SwaggerUiConfigProperties
 
setWebjars(SpringDocConfigProperties.Webjars) - Method in class org.springdoc.core.SpringDocConfigProperties
 
setWithApiResponseDoc(boolean) - Method in class org.springdoc.core.MethodAttributes
 
splitCamelCase(String) - Static method in class org.springdoc.core.OpenAPIBuilder
 
SPRINGDOC_ACTUATOR_DESCRIPTION - Static variable in class org.springdoc.core.Constants
 
SPRINGDOC_ACTUATOR_DOC_DESCRIPTION - Static variable in class org.springdoc.core.Constants
 
SPRINGDOC_ACTUATOR_DOC_URL - Static variable in class org.springdoc.core.Constants
 
SPRINGDOC_ACTUATOR_TAG - Static variable in class org.springdoc.core.Constants
 
SPRINGDOC_CACHE_DISABLED - Static variable in class org.springdoc.core.Constants
 
SPRINGDOC_ENABLED - Static variable in class org.springdoc.core.Constants
 
SPRINGDOC_OAUTH2_REDIRECT_URL - Static variable in class org.springdoc.core.Constants
 
SPRINGDOC_OAUTH2_REDIRECT_URL_VALUE - Static variable in class org.springdoc.core.Constants
 
SPRINGDOC_PREFIX - Static variable in class org.springdoc.core.Constants
 
SPRINGDOC_SCHEMA_RESOLVE_PROPERTIES - Static variable in class org.springdoc.core.Constants
 
SPRINGDOC_SHOW_ACTUATOR - Static variable in class org.springdoc.core.Constants
 
SPRINGDOC_SWAGGER_UI_CONFIG_URL - Static variable in class org.springdoc.core.Constants
 
SPRINGDOC_SWAGGER_UI_CONFIG_URL_VALUE - Static variable in class org.springdoc.core.Constants
 
SPRINGDOC_SWAGGER_UI_ENABLED - Static variable in class org.springdoc.core.Constants
 
SPRINGDOC_SWAGGER_UI_URL - Static variable in class org.springdoc.core.Constants
 
SPRINGDOC_SWAGGER_UI_URL_VALUE - Static variable in class org.springdoc.core.Constants
 
SpringDocAnnotationsUtils - Class in org.springdoc.core
 
SpringDocAnnotationsUtils() - Constructor for class org.springdoc.core.SpringDocAnnotationsUtils
 
springDocConfigProperties - Variable in class org.springdoc.api.AbstractOpenApiResource
 
SpringDocConfigProperties - Class in org.springdoc.core
 
SpringDocConfigProperties() - Constructor for class org.springdoc.core.SpringDocConfigProperties
 
springDocConfigProperties - Variable in class org.springdoc.ui.AbstractSwaggerWelcome
 
SpringDocConfigProperties.ApiDocs - Class in org.springdoc.core
 
SpringDocConfigProperties.Cache - Class in org.springdoc.core
 
SpringDocConfigProperties.GroupConfig - Class in org.springdoc.core
 
SpringDocConfigProperties.Groups - Class in org.springdoc.core
 
SpringDocConfigProperties.Webjars - Class in org.springdoc.core
 
SpringDocConfiguration - Class in org.springdoc.core
 
SpringDocConfiguration() - Constructor for class org.springdoc.core.SpringDocConfiguration
 
SpringDocPropertiesUtils - Interface in org.springdoc.core
 
SpringDocUIException - Exception in org.springdoc.ui
 
SpringDocUIException(String, Throwable) - Constructor for exception org.springdoc.ui.SpringDocUIException
 
SpringDocUtils - Class in org.springdoc.core
 
SWAGGER_CONFIG_URL - Static variable in class org.springdoc.core.Constants
 
SWAGGER_UI_OAUTH_REDIRECT_URL - Static variable in class org.springdoc.core.Constants
 
SWAGGER_UI_PATH - Static variable in class org.springdoc.core.Constants
 
SWAGGER_UI_URL - Static variable in class org.springdoc.core.Constants
 
swaggerUiConfig - Variable in class org.springdoc.ui.AbstractSwaggerWelcome
 
SwaggerUiConfigProperties - Class in org.springdoc.core
Please refer to the swagger configuration.md to get the idea what each parameter does.
SwaggerUiConfigProperties() - Constructor for class org.springdoc.core.SwaggerUiConfigProperties
 
SwaggerUiOAuthProperties - Class in org.springdoc.core
Please refer to the swagger configuration.md to get the idea what each parameter does.
SwaggerUiOAuthProperties() - Constructor for class org.springdoc.core.SwaggerUiOAuthProperties
 
swaggerUiOAuthProperties - Variable in class org.springdoc.ui.AbstractSwaggerIndexTransformer
 
SWAGGGER_CONFIG_FILE - Static variable in class org.springdoc.core.Constants
 

T

TRACE_METHOD - Static variable in class org.springdoc.core.Constants
 
type() - Method in class org.springdoc.core.RequestInfo
 

U

uiRootPath - Variable in class org.springdoc.ui.AbstractSwaggerWelcome
 
updateServers(OpenAPI) - Method in class org.springdoc.core.OpenAPIBuilder
 

V

value() - Method in class org.springdoc.core.RequestInfo
 

W

WEB_JARS_PREFIX_URL - Static variable in class org.springdoc.core.Constants
 
Webjars() - Constructor for class org.springdoc.core.SpringDocConfigProperties.Webjars
 
A B C D E F G H I L M N O P Q R S T U V W 
Skip navigation links

Copyright © 2020. All rights reserved.