A B C D G H I M O P Q R S T V W

A

AbstractOpenApiResource - Class in org.springdoc.api

AbstractOpenApiResource(OpenAPIBuilder, AbstractRequestBuilder, AbstractResponseBuilder, OperationBuilder, Optional<List<OpenApiCustomiser>>) - Constructor for class org.springdoc.api.AbstractOpenApiResource

AbstractOpenApiResource(OpenAPIBuilder, AbstractRequestBuilder, AbstractResponseBuilder, OperationBuilder, Optional<List<OpenApiCustomiser>>, List<String>, List<String>) - Constructor for class org.springdoc.api.AbstractOpenApiResource

AbstractParameterBuilder - Class in org.springdoc.core

AbstractParameterBuilder(LocalVariableTableParameterNameDiscoverer, IgnoredParameterAnnotations) - Constructor for class org.springdoc.core.AbstractParameterBuilder

AbstractRequestBuilder - Class in org.springdoc.core

AbstractRequestBuilder(AbstractParameterBuilder, RequestBodyBuilder, OperationBuilder, Optional<List<OperationCustomizer>>, Optional<List<ParameterCustomizer>>) - Constructor for class org.springdoc.core.AbstractRequestBuilder

AbstractResponseBuilder - Class in org.springdoc.core

AbstractResponseBuilder(OperationBuilder) - Constructor for class org.springdoc.core.AbstractResponseBuilder

addGroup(String) - Static method in class org.springdoc.core.SwaggerUiConfigProperties

addGroup(String, String) - Static method in class org.springdoc.core.SwaggerUiConfigProperties

addOpenApiCustomiser(OpenApiCustomiser) - Method in class org.springdoc.core.GroupedOpenApi.Builder

addTag(Set<HandlerMethod>, String) - Method in class org.springdoc.core.OpenAPIBuilder

addUrl(String) - Static method in class org.springdoc.core.SwaggerUiConfigProperties

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(Components, HandlerMethod, RequestMethod, Operation, MethodAttributes) - Method in class org.springdoc.core.AbstractRequestBuilder

build(Components, HandlerMethod, Operation, MethodAttributes) - Method in class org.springdoc.core.AbstractResponseBuilder

build() - Method in class org.springdoc.core.GroupedOpenApi.Builder

build() - Method in class org.springdoc.core.OpenAPIBuilder

buildCallbacks(List<Callback>, Components, OpenAPI, MethodAttributes) - Method in class org.springdoc.core.OperationBuilder

builder() - Static method in class org.springdoc.core.GroupedOpenApi

buildGenericResponse(Components, Map<String, Object>) - Method in class org.springdoc.core.AbstractResponseBuilder

buildRequestBodyFromDoc(RequestBody, String[], String[], Components, JsonView) - Method in class org.springdoc.core.RequestBodyBuilder

buildTags(HandlerMethod, Operation, OpenAPI) - Method in class org.springdoc.core.OpenAPIBuilder

C

calculateConsumesProduces(Method) - Method in class org.springdoc.core.MethodAttributes

calculatePath(OpenAPIBuilder, HandlerMethod, String, Set<RequestMethod>) - Method in class org.springdoc.api.AbstractOpenApiResource

calculateRequestBodyInfo(Components, HandlerMethod, MethodAttributes, int, ParameterInfo, RequestBodyInfo) - Method in class org.springdoc.core.RequestBodyBuilder

calculateSchemaFromParameterizedType(Components, Type, JsonView) - Method in class org.springdoc.core.AbstractParameterBuilder

calculateSchemaFromParameterizedType(Components, ParameterizedType, JsonView) - Method in class org.springdoc.core.AbstractResponseBuilder

calculateSchemaParameterizedType(Components, ParameterizedType, JsonView) - Method in class org.springdoc.core.AbstractResponseBuilder

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

Constants - Class in org.springdoc.core

customise(OpenAPI) - Method in interface org.springdoc.core.customizers.OpenApiCustomiser

customiseOperation(Operation, HandlerMethod) - Method in class org.springdoc.core.AbstractRequestBuilder

customiseParameter(Parameter, ParameterInfo, HandlerMethod) - Method in class org.springdoc.core.AbstractRequestBuilder

customize(Operation, HandlerMethod) - Method in interface org.springdoc.core.customizers.OperationCustomizer

customize(Parameter, Parameter, HandlerMethod) - 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_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

G

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

getAllConsumes() - Method in class org.springdoc.core.MethodAttributes

getAllProduces() - Method in class org.springdoc.core.MethodAttributes

getApiDocs() - Method in class org.springdoc.core.SpringDocConfigProperties

getClassConsumes() - Method in class org.springdoc.core.MethodAttributes

getClassProduces() - Method in class org.springdoc.core.MethodAttributes

getComponents() - Method in class org.springdoc.core.OpenAPIBuilder

getConfigParameters() - Method in class org.springdoc.core.SwaggerUiConfigProperties

getConfigUrl() - Method in class org.springdoc.core.SwaggerUiConfigProperties

getControllerAdviceMap() - Method in class org.springdoc.core.OpenAPIBuilder

getDeepLinking() - Method in class org.springdoc.core.SwaggerUiConfigProperties

getDefaultModelExpandDepth() - Method in class org.springdoc.core.SwaggerUiConfigProperties

getDefaultModelRendering() - Method in class org.springdoc.core.SwaggerUiConfigProperties

getDefaultModelsExpandDepth() - Method in class org.springdoc.core.SwaggerUiConfigProperties

getDisplayOperationId() - Method in class org.springdoc.core.SwaggerUiConfigProperties

getDisplayRequestDuration() - Method in class org.springdoc.core.SwaggerUiConfigProperties

getDocExpansion() - Method in class org.springdoc.core.SwaggerUiConfigProperties

getEnabled() - Method in class org.springdoc.core.SpringDocConfigProperties.ApiDocs

getEnabled() - Method in class org.springdoc.core.SpringDocConfigProperties.Groups

getFilter() - Method in class org.springdoc.core.SwaggerUiConfigProperties

getGroup() - Method in class org.springdoc.core.GroupedOpenApi

getGroups() - Method in class org.springdoc.core.SpringDocConfigProperties.ApiDocs

getJsonViewAnnotation() - Method in class org.springdoc.core.MethodAttributes

getJsonViewAnnotationForRequestBody() - Method in class org.springdoc.core.MethodAttributes

getLayout() - Method in class org.springdoc.core.SwaggerUiConfigProperties

getLocalSpringDocParameterNameDiscoverer() - Method in class org.springdoc.core.AbstractParameterBuilder

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

getOpenAPI() - Method in class org.springdoc.core.OpenAPIBuilder

getOpenApiCustomisers() - Method in class org.springdoc.core.GroupedOpenApi

getOperationId(String, String) - Method in class org.springdoc.core.OperationBuilder

getOperationsSorter() - Method in class org.springdoc.core.SwaggerUiConfigProperties

getPackagesToScan() - Method in class org.springdoc.core.GroupedOpenApi

getPackagesToScan() - Method in class org.springdoc.core.SpringDocConfigProperties

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

getPaths() - Method in class org.springdoc.core.OpenAPIBuilder

getPathsToMatch() - Method in class org.springdoc.core.GroupedOpenApi

getPathsToMatch() - Method in class org.springdoc.core.SpringDocConfigProperties

getPrefix() - Method in class org.springdoc.core.SpringDocConfigProperties.Webjars

getRequestBodyBuilder() - Method in class org.springdoc.core.AbstractRequestBuilder

getRequestMappingMap() - Method in class org.springdoc.core.OpenAPIBuilder

getRestControllersMap() - Method in class org.springdoc.core.OpenAPIBuilder

getShowActuator() - Method in class org.springdoc.core.SpringDocConfigProperties

getShowCommonExtensions() - Method in class org.springdoc.core.SwaggerUiConfigProperties

getShowExtensions() - Method in class org.springdoc.core.SwaggerUiConfigProperties

getSupportedSubmitMethods() - Method in class org.springdoc.core.SwaggerUiConfigProperties

getSwaggerUrls() - Static method in class org.springdoc.core.SwaggerUiConfigProperties

getTagsSorter() - Method in class org.springdoc.core.SwaggerUiConfigProperties

getUrl() - Method in class org.springdoc.core.SwaggerUiConfigProperties

getValidatorUrl() - Method in class org.springdoc.core.SwaggerUiConfigProperties

getWebjars() - Method in class org.springdoc.core.SpringDocConfigProperties

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

IgnoredParameterAnnotations - Interface in org.springdoc.core

IgnoredParameterAnnotationsDefault - Class in org.springdoc.core

IgnoredParameterAnnotationsDefault() - Constructor for class org.springdoc.core.IgnoredParameterAnnotationsDefault

isAnnotationToIgnore(Parameter) - Method in class org.springdoc.core.AbstractParameterBuilder

isAnnotationToIgnore(Parameter) - Method in interface org.springdoc.core.IgnoredParameterAnnotations

isFile(ParameterizedType) - Method in class org.springdoc.core.AbstractParameterBuilder

isFile(JavaType) - Method in class org.springdoc.core.AbstractParameterBuilder

isHidden(Method) - Method in class org.springdoc.core.OperationBuilder

isMethodOverloaded() - Method in class org.springdoc.core.MethodAttributes

isNoApiResponseDoc() - Method in class org.springdoc.core.MethodAttributes

isPackageToScan(String) - Method in class org.springdoc.api.AbstractOpenApiResource

isParamToIgnore(Parameter) - Method in class org.springdoc.core.AbstractRequestBuilder

isPathToMatch(String) - Method in class org.springdoc.api.AbstractOpenApiResource

isValidUrl(String) - Method in class org.springdoc.core.SwaggerUiConfigProperties

M

MethodAttributes - Class in org.springdoc.core

MethodAttributes(String[]) - Constructor for class org.springdoc.core.MethodAttributes

MethodAttributes() - Constructor for class org.springdoc.core.MethodAttributes

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

O

ObjectNodeConverter - Class in org.springdoc.core.converters

ObjectNodeConverter() - Constructor for class org.springdoc.core.converters.ObjectNodeConverter

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

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

OpenAPIBuilder - Class in org.springdoc.core

openAPIBuilder(Optional<OpenAPI>, ApplicationContext, SecurityParser, List<ModelConverter>) - Method in class org.springdoc.core.SpringDocConfiguration

OpenApiCustomiser - Interface in org.springdoc.core.customizers

OperationBuilder - Class in org.springdoc.core

OperationBuilder(AbstractParameterBuilder, RequestBodyBuilder, SecurityParser, OpenAPIBuilder, PropertyResolverUtils) - Constructor for class org.springdoc.core.OperationBuilder

operationBuilder(AbstractParameterBuilder, RequestBodyBuilder, SecurityParser, OpenAPIBuilder, PropertyResolverUtils) - Method in class org.springdoc.core.SpringDocConfiguration

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.core - package org.springdoc.core

org.springdoc.core.converters - package org.springdoc.core.converters

org.springdoc.core.customizers - package org.springdoc.core.customizers

P

packagesToScan(String...) - Method in class org.springdoc.core.GroupedOpenApi.Builder

PARAM_TYPES_TO_IGNORE - Static variable in class org.springdoc.core.AbstractRequestBuilder

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

parse(Components, Operation, Operation, OpenAPI, MethodAttributes) - Method in class org.springdoc.core.OperationBuilder

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

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

propertyResolverUtils(ConfigurableBeanFactory) - Method in class org.springdoc.core.SpringDocConfiguration

put(String, List<SwaggerUiConfigProperties.SwaggerUrl>, Map<String, Object>) - Method in class org.springdoc.core.SwaggerUiConfigProperties

put(String, Integer, Map<String, Object>) - Method in class org.springdoc.core.SwaggerUiConfigProperties

put(String, Boolean, Map<String, Object>) - Method in class org.springdoc.core.SwaggerUiConfigProperties

put(String, String, Map<String, Object>) - Method in class org.springdoc.core.SwaggerUiConfigProperties

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

Q

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

R

RequestBodyBuilder - Class in org.springdoc.core

RequestBodyBuilder(AbstractParameterBuilder) - Constructor for class org.springdoc.core.RequestBodyBuilder

requestBodyBuilder(AbstractParameterBuilder) - Method in class org.springdoc.core.SpringDocConfiguration

RequestInfo - Class in org.springdoc.core

RequestInfo(RequestInfo.ParameterType, String, boolean, String) - Constructor for class org.springdoc.core.RequestInfo

RequestInfo.ParameterType - Enum in org.springdoc.core

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

resolve(AnnotatedType, ModelConverterContext, Iterator<ModelConverter>) - Method in class org.springdoc.core.converters.ObjectNodeConverter

resolve(AnnotatedType, ModelConverterContext, Iterator<ModelConverter>) - Method in class org.springdoc.core.converters.PropertyCustomizingConverter

S

securityParser(PropertyResolverUtils) - Method in class org.springdoc.core.SpringDocConfiguration

setApiDocs(SpringDocConfigProperties.ApiDocs) - Method in class org.springdoc.core.SpringDocConfigProperties

setClassConsumes(String[]) - Method in class org.springdoc.core.MethodAttributes

setClassProduces(String[]) - Method in class org.springdoc.core.MethodAttributes

setConfigUrl(String) - Method in class org.springdoc.core.SwaggerUiConfigProperties

setDeepLinking(Boolean) - Method in class org.springdoc.core.SwaggerUiConfigProperties

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

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

setGroups(SpringDocConfigProperties.Groups) - Method in class org.springdoc.core.SpringDocConfigProperties.ApiDocs

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

setOauth2RedirectUrl(String) - Method in class org.springdoc.core.SwaggerUiConfigProperties

setOperationsSorter(String) - Method in class org.springdoc.core.SwaggerUiConfigProperties

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

setPathsToMatch(List<String>) - Method in class org.springdoc.core.SpringDocConfigProperties

setPrefix(String) - Method in class org.springdoc.core.SpringDocConfigProperties.Webjars

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

setSwaggerUrls(List<SwaggerUiConfigProperties.SwaggerUrl>) - Static 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

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

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

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

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

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

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

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

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

SpringDocConfigProperties - Class in org.springdoc.core

SpringDocConfigProperties() - Constructor for class org.springdoc.core.SpringDocConfigProperties

SpringDocConfigProperties.ApiDocs - 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

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

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

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

T

toString() - Method in enum org.springdoc.core.RequestInfo.ParameterType

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

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

V

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

valueOf(String) - Static method in enum org.springdoc.core.RequestInfo.ParameterType

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.springdoc.core.RequestInfo.ParameterType

Returns an array containing the constants of this enum type, in the order they are declared.

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 G H I M O P Q R S T V W