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

The type Abstract open api resource.

AbstractOpenApiResource(String, ObjectFactory<OpenAPIBuilder>, AbstractRequestBuilder, GenericResponseBuilder, OperationBuilder, Optional<List<OperationCustomizer>>, Optional<List<OpenApiCustomiser>>, SpringDocConfigProperties, Optional<ActuatorProvider>) - Constructor for class org.springdoc.api.AbstractOpenApiResource

Instantiates a new Abstract open api resource.

AbstractRequestBuilder - Class in org.springdoc.core

The type Abstract request builder.

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

Instantiates a new Abstract request builder.

AbstractRouterFunctionVisitor - Class in org.springdoc.core.fn

The type Abstract router function visitor.

AbstractRouterFunctionVisitor() - Constructor for class org.springdoc.core.fn.AbstractRouterFunctionVisitor

AbstractSwaggerIndexTransformer - Class in org.springdoc.ui

The type Abstract swagger index transformer.

AbstractSwaggerIndexTransformer(SwaggerUiConfigProperties, SwaggerUiOAuthProperties, ObjectMapper) - Constructor for class org.springdoc.ui.AbstractSwaggerIndexTransformer

Instantiates a new Abstract swagger index transformer.

AbstractSwaggerUiConfigProperties - Class in org.springdoc.core

Please refer to the swagger configuration.md to get the idea what each parameter does.

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

AbstractSwaggerUiConfigProperties.SwaggerUrl - Class in org.springdoc.core

The type Swagger url.

AbstractSwaggerWelcome - Class in org.springdoc.ui

The type Abstract swagger welcome.

AbstractSwaggerWelcome(SwaggerUiConfigProperties, SpringDocConfigProperties, SwaggerUiConfigParameters) - Constructor for class org.springdoc.ui.AbstractSwaggerWelcome

Instantiates a new Abstract swagger welcome.

ActuatorOpenApiCustomiser - Class in org.springdoc.core.customizers

The type Actuator open api customiser.

ActuatorOpenApiCustomiser() - Constructor for class org.springdoc.core.customizers.ActuatorOpenApiCustomiser

ActuatorOperationCustomizer - Class in org.springdoc.core.customizers

The type Actuator operation customizer.

ActuatorOperationCustomizer(ActuatorProvider) - Constructor for class org.springdoc.core.customizers.ActuatorOperationCustomizer

Instantiates a new Actuator operation customizer.

actuatorProvider - Variable in class org.springdoc.api.AbstractOpenApiResource

The Actuator provider.

ActuatorProvider - Interface in org.springdoc.core

The interface Actuator provider.

addAnnotationsToIgnore(Class<?>...) - Static method in class org.springdoc.core.SpringDocAnnotationsUtils

Add annotations to ignore.

addAnnotationsToIgnore(Class<?>...) - Method in class org.springdoc.core.SpringDocUtils

Add annotations to ignore spring doc utils.

addConsumes(String) - Method in class org.springdoc.core.fn.RouterFunctionData

Add consumes.

addCSRF(String) - Method in class org.springdoc.ui.AbstractSwaggerIndexTransformer

Add csrf string.

addDeprecatedType(Class<? extends Annotation>) - Static method in class org.springdoc.core.converters.SchemaPropertyDeprecatingConverter

Add deprecated type.

addDeprecatedType(Class<? extends Annotation>) - Method in class org.springdoc.core.SpringDocUtils

Add deprecated type spring doc utils.

addFileType(Class<?>...) - Static method in class org.springdoc.core.GenericParameterBuilder

Add file type.

addFileType(Class<?>...) - Method in class org.springdoc.core.SpringDocUtils

Add file type spring doc utils.

addFluxWrapperToIgnore(Class<?>) - Static method in class org.springdoc.core.converters.ConverterUtils

Add flux wrapper to ignore.

addFluxWrapperToIgnore(Class<?>) - Method in class org.springdoc.core.SpringDocUtils

Add flux wrapper to ignore spring doc utils.

addGroup(String) - Method in class org.springdoc.core.SwaggerUiConfigParameters

Add group.

addGroupConfig(SpringDocConfigProperties.GroupConfig) - Method in class org.springdoc.core.SpringDocConfigProperties

Add group config.

addHeaders(String) - Method in class org.springdoc.core.fn.RouterFunctionData

Add headers.

addHiddenRestControllers(Class<?>...) - Static method in class org.springdoc.api.AbstractOpenApiResource

Add hidden rest controllers.

addHiddenRestControllers(String...) - Static method in class org.springdoc.api.AbstractOpenApiResource

Add hidden rest controllers.

addHiddenRestControllers(Class<?>...) - Method in class org.springdoc.core.SpringDocUtils

Add hidden rest controllers spring doc utils.

addHiddenRestControllers(String...) - Method in class org.springdoc.core.SpringDocUtils

Add hidden rest controllers spring doc utils.

addInitOauth(String) - Method in class org.springdoc.ui.AbstractSwaggerIndexTransformer

Add init oauth string.

AdditionalModelsConverter - Class in org.springdoc.core.converters

The type Additional models converter.

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

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

Add mappings.

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

Add open api customiser builder.

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

Add operation customizer builder.

addProduces(String) - Method in class org.springdoc.core.fn.RouterFunctionData

Add produces.

addProperties(String, Schema) - Method in class org.springdoc.core.RequestBodyInfo

Add properties.

addQueryParams(String, String) - Method in class org.springdoc.core.fn.RouterFunctionData

Add query params.

addRequestWrapperToIgnore(Class<?>...) - Static method in class org.springdoc.core.AbstractRequestBuilder

Add request wrapper to ignore.

addRequestWrapperToIgnore(Class<?>...) - Method in class org.springdoc.core.SpringDocUtils

Add request wrapper to ignore spring doc utils.

addResponseTypeToIgnore(Class<?>) - Static method in class org.springdoc.core.converters.ConverterUtils

Add response type to ignore.

addResponseTypeToIgnore(Class<?>) - Method in class org.springdoc.core.SpringDocUtils

Add response type to ignore spring doc utils.

addResponseWrapperToIgnore(Class<?>) - Static method in class org.springdoc.core.converters.ConverterUtils

Add response wrapper to ignore.

addResponseWrapperToIgnore(Class<?>) - Method in class org.springdoc.core.SpringDocUtils

Add response wrapper to ignore spring doc utils.

addRestControllers(Class<?>...) - Static method in class org.springdoc.api.AbstractOpenApiResource

Add rest controllers.

addRestControllers(Class<?>...) - Method in class org.springdoc.core.SpringDocUtils

Add rest controllers spring doc utils.

addSimpleTypePredicateForParameterObject(Predicate<Class<?>>) - Method in class org.springdoc.core.SpringDocUtils

Add simple type predicate for parameter object spring doc utils.

addSimpleTypesForParameterObject(Class<?>...) - Method in class org.springdoc.core.SpringDocUtils

Add simple types for parameter object spring doc utils.

addSort(String) - Method in class org.springdoc.core.converters.models.Pageable

Add sort.

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

Add tag.

addUrl(String) - Method in class org.springdoc.core.SwaggerUiConfigParameters

Add url.

afterPropertiesSet() - Method in class org.springdoc.ui.AbstractSwaggerWelcome

and() - Method in class org.springdoc.core.fn.AbstractRouterFunctionVisitor

And.

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

The constant API_DOCS_URL.

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

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

The constant APPLICATION_OPENAPI_YAML.

applyBeanValidatorAnnotations(Parameter, List<Annotation>) - Method in class org.springdoc.core.AbstractRequestBuilder

Apply bean validator annotations.

applyBeanValidatorAnnotations(RequestBody, List<Annotation>, boolean) - Method in class org.springdoc.core.AbstractRequestBuilder

Apply bean validator annotations.

B

build(HandlerMethod, RequestMethod, Operation, MethodAttributes, OpenAPI) - Method in class org.springdoc.core.AbstractRequestBuilder

Build operation.

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

Build api responses.

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

Build grouped open api.

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

Build.

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

Build callbacks optional.

buildConfigUrl(String, UriComponentsBuilder) - Method in class org.springdoc.ui.AbstractSwaggerWelcome

Build config url.

buildContent(Components, Annotation[], String[], JsonView, Type) - Method in class org.springdoc.core.GenericResponseBuilder

Build content content.

buildContentFromDoc(Components, ApiResponses, MethodAttributes, ApiResponse, ApiResponse) - Static method in class org.springdoc.core.GenericResponseBuilder

Build content from doc.

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

Builder builder.

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

Build generic response.

buildParameterFromDoc(Parameter, Components, JsonView) - Method in class org.springdoc.core.GenericParameterBuilder

Build parameter from doc parameter.

buildParams(ParameterInfo, Components, RequestMethod, JsonView) - Method in class org.springdoc.core.AbstractRequestBuilder

Build params parameter.

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

Build request body from doc optional.

buildRequestBodyFromDoc(RequestBody, MethodAttributes, Components) - Method in class org.springdoc.core.RequestBodyBuilder

Build request body from doc optional.

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

Build request body from doc optional.

buildRequestBodyFromDoc(RequestBody, RequestBody, MethodAttributes, Components) - Method in class org.springdoc.core.RequestBodyBuilder

Build request body from doc optional.

buildSecurityRequirement(SecurityRequirement[], Operation) - Method in class org.springdoc.core.SecurityParser

Build security requirement.

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

Build tags operation.

buildTagsFromClass(Class<?>, Set<Tag>, Set<String>) - Method in class org.springdoc.core.OpenAPIBuilder

buildUrl(String, String) - Method in class org.springdoc.ui.AbstractSwaggerWelcome

Build url string.

C

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

CacheOrGroupedOpenApiCondition - Class in org.springdoc.core

The type Cache or grouped open api condition.

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

Calculate consumes produces.

calculateGenericMapResponse(Map<String, ApiResponse>) - Method in class org.springdoc.core.MethodAttributes

Calculate generic map response api responses.

calculateOauth2RedirectUrl(UriComponentsBuilder) - Method in class org.springdoc.ui.AbstractSwaggerWelcome

Calculate oauth 2 redirect url.

calculatePath(HandlerMethod, RouterOperation) - Method in class org.springdoc.api.AbstractOpenApiResource

Calculate path.

calculatePath(List<RouterOperation>) - Method in class org.springdoc.api.AbstractOpenApiResource

Calculate path.

calculatePath(RouterOperation) - Method in class org.springdoc.api.AbstractOpenApiResource

Calculate path.

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

Calculate path.

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

Calculate request body info.

calculateUiRootPath(StringBuilder...) - Method in class org.springdoc.ui.AbstractSwaggerWelcome

Calculate ui root path.

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

The constant CLASSPATH_RESOURCE_LOCATION.

compareTo(RouterOperation) - Method in class org.springdoc.core.fn.RouterOperation

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

The constant CONFIG_URL_PROPERTY.

configUrl - Variable in class org.springdoc.core.AbstractSwaggerUiConfigProperties

URL to fetch external configuration document from.

Constants - Class in org.springdoc.core

The type Constants.

containsDeprecatedAnnotation(Annotation[]) - Static method in class org.springdoc.core.converters.SchemaPropertyDeprecatingConverter

Contains deprecated annotation boolean.

ControllerAdviceInfo - Class in org.springdoc.core

The type Controller advice info.

ControllerAdviceInfo(Object) - Constructor for class org.springdoc.core.ControllerAdviceInfo

Instantiates a new Controller advice info.

ConverterUtils - Class in org.springdoc.core.converters

The type Converter utils.

Csrf() - Constructor for class org.springdoc.core.SwaggerUiConfigProperties.Csrf

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

The constant CSRF_DEFAULT_COOKIE_NAME.

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

The constant CSRF_DEFAULT_HEADER_NAME.

customise(OpenAPI) - Method in class org.springdoc.core.customizers.ActuatorOpenApiCustomiser

customise(OpenAPIBuilder) - Method in interface org.springdoc.core.customizers.OpenApiBuilderCustomiser

Customise.

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

Customise.

customiseOperation(Operation, HandlerMethod) - Method in class org.springdoc.api.AbstractOpenApiResource

Customise operation operation.

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

Customise parameter parameter.

customize(Operation, HandlerMethod) - Method in class org.springdoc.core.customizers.ActuatorOperationCustomizer

customize(MethodParameter, MethodParameter) - Method in interface org.springdoc.core.customizers.DelegatingMethodParameterCustomizer

Customize.

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

Customize operation.

customize(Parameter, MethodParameter) - Method in interface org.springdoc.core.customizers.ParameterCustomizer

Customize parameter.

customize(Schema, AnnotatedType) - Method in interface org.springdoc.core.customizers.PropertyCustomizer

Customize schema.

customize(String[], MethodParameter[], Optional<DelegatingMethodParameterCustomizer>) - Static method in class org.springdoc.core.DelegatingMethodParameter

Customize method parameter [ ].

D

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

Decode string.

deepLinking - Variable in class org.springdoc.core.AbstractSwaggerUiConfigProperties

Enables or disables deep linking for tags and operations.

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

The constant DEFAULT_API_DOCS_URL.

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

The constant DEFAULT_API_DOCS_URL_YAML.

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

The constant DEFAULT_DESCRIPTION.

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

The constant DEFAULT_GROUP_NAME.

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

The constant DEFAULT_SERVER_DESCRIPTION.

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

The constant DEFAULT_SWAGGER_UI_PATH.

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

The constant DEFAULT_TITLE.

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

The constant DEFAULT_VERSION.

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

The constant DEFAULT_WEB_JARS_PREFIX_URL.

defaultModelExpandDepth - Variable in class org.springdoc.core.AbstractSwaggerUiConfigProperties

The default expansion depth for the model on the model-example section.

defaultModelRendering - Variable in class org.springdoc.core.AbstractSwaggerUiConfigProperties

Controls how the model is shown when the API is first rendered.

defaultModelsExpandDepth - Variable in class org.springdoc.core.AbstractSwaggerUiConfigProperties

The default expansion depth for models (set to -1 completely hide the models).

DefaultPageable - Class in org.springdoc.core.converters.models

The type Default pageable.

DefaultPageable(int, int, List<String>) - Constructor for class org.springdoc.core.converters.models.DefaultPageable

Instantiates a new Default pageable.

defaultTransformations(InputStream) - Method in class org.springdoc.ui.AbstractSwaggerIndexTransformer

Default transformations string.

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

Default value string.

DelegatingMethodParameter - Class in org.springdoc.core

The type Delegating method parameter.

DelegatingMethodParameterCustomizer - Interface in org.springdoc.core.customizers

The interface Delegating method parameter customizer.

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

The constant DELETE_METHOD.

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

disableReplacement(Class) - Static method in class org.springdoc.core.converters.AdditionalModelsConverter

Disable replacement.

disableReplacement(Class) - Method in class org.springdoc.core.SpringDocUtils

Disable replacement spring doc utils.

displayOperationId - Variable in class org.springdoc.core.AbstractSwaggerUiConfigProperties

Controls the display of operationId in operations list.

displayRequestDuration - Variable in class org.springdoc.core.AbstractSwaggerUiConfigProperties

Controls the display of the request duration (in milliseconds) for Try-It-Out requests.

docExpansion - Variable in class org.springdoc.core.AbstractSwaggerUiConfigProperties

Controls the default expansion setting for the operations and tags.

E

endAnd() - Method in class org.springdoc.core.fn.AbstractRouterFunctionVisitor

End and.

endNegate() - Method in class org.springdoc.core.fn.AbstractRouterFunctionVisitor

End negate.

endOr() - Method in class org.springdoc.core.fn.AbstractRouterFunctionVisitor

End or.

equals(Object) - Method in class org.springdoc.core.AbstractSwaggerUiConfigProperties.SwaggerUrl

equals(Object) - Method in class org.springdoc.core.converters.models.Pageable

equals(Object) - Method in class org.springdoc.core.DelegatingMethodParameter

equals(Object) - Method in class org.springdoc.core.fn.RouterOperation

ErrorMessage - Class in org.springdoc.api

The type Error message.

ErrorMessage(String) - Constructor for class org.springdoc.api.ErrorMessage

Instantiates a new Error message.

evaluateResponseStatus(Method, Class<?>, boolean) - Method in class org.springdoc.core.GenericResponseBuilder

Evaluate response status string.

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

Extract schema schema.

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

Extract schema schema.

F

FileSupportConverter - Class in org.springdoc.core.converters

The type File support converter.

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

filter - Variable in class org.springdoc.core.AbstractSwaggerUiConfigProperties

If set, enables filtering.

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

The constant FILTER_PROPERTY.

findTypeForGenerics(Class<?>[], Type[], ResolvableType) - Static method in interface org.springdoc.core.ReturnTypeParser

Find type for generics.

G

GenericParameterBuilder - Class in org.springdoc.core

The type Generic parameter builder.

GenericParameterBuilder(PropertyResolverUtils, Optional<DelegatingMethodParameterCustomizer>) - Constructor for class org.springdoc.core.GenericParameterBuilder

Instantiates a new Generic parameter builder.

GenericResponseBuilder - Class in org.springdoc.core

The type Generic response builder.

GenericResponseBuilder(OperationBuilder, List<ReturnTypeParser>, SpringDocConfigProperties, PropertyResolverUtils) - Constructor for class org.springdoc.core.GenericResponseBuilder

Instantiates a new Generic response builder.

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

The constant GET_METHOD.

getAdditionalQueryStringParams() - Method in class org.springdoc.core.SwaggerUiOAuthProperties

Gets additional query string params.

getAnnotatedElement() - Method in class org.springdoc.core.DelegatingMethodParameter

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

Gets api docs.

getApiResponseMap() - Method in class org.springdoc.core.ControllerAdviceInfo

Gets api response map.

getAppName() - Method in class org.springdoc.core.SwaggerUiOAuthProperties

Gets app name.

getBeanClass() - Method in class org.springdoc.core.fn.RouterOperation

Gets bean class.

getBeanMethod() - Method in class org.springdoc.core.fn.RouterOperation

Gets bean method.

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

Gets cache.

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

Gets cached open api.

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

Gets calculated open api.

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

Get class consumes string [ ].

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

Get class produces string [ ].

getClientId() - Method in class org.springdoc.core.SwaggerUiOAuthProperties

Gets client id.

getClientSecret() - Method in class org.springdoc.core.SwaggerUiOAuthProperties

Gets client secret.

getConfig() - Static method in class org.springdoc.core.SpringDocUtils

Gets config.

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

Gets config parameters.

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

Gets config parameters.

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

Gets config url.

getConstructor() - Method in class org.springdoc.core.DelegatingMethodParameter

getConsumes() - Method in class org.springdoc.core.fn.RouterFunctionData

Get consumes string [ ].

getConsumes() - Method in class org.springdoc.core.fn.RouterOperation

Get consumes string [ ].

getContainingClass() - Method in class org.springdoc.core.DelegatingMethodParameter

getContent(Content[], String[], String[], Schema, Components, JsonView) - Static method in class org.springdoc.core.SpringDocAnnotationsUtils

Gets content.

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

Gets context.

getControllerAdvice() - Method in class org.springdoc.core.ControllerAdviceInfo

Gets controller advice.

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

Gets controller advice map.

getCookieName() - Method in class org.springdoc.core.SwaggerUiConfigProperties.Csrf

Gets cookie name.

getCookieValue() - Method in class org.springdoc.core.ParameterInfo

Gets cookie value.

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

Gets csrf.

getDeclaringClass() - Method in class org.springdoc.core.DelegatingMethodParameter

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

Gets deep linking.

getDefaultAllowedHttpMethods() - Method in class org.springdoc.api.AbstractOpenApiResource

Gets default allowed http methods.

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

Gets default consumes media type.

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

Gets default model expand depth.

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

Gets default model rendering.

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

Gets default models expand depth.

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

Gets default produces media type.

getDelegatingMethodParameterCustomizer() - Method in class org.springdoc.core.GenericParameterBuilder

Gets delegating method parameter customizer.

getDeprecatingConverter() - Method in class org.springdoc.core.SpringDocConfigProperties.ModelConverters

Gets deprecating converter.

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

Gets display operation id.

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

Gets display request duration.

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

Gets doc expansion.

getExecutable() - Method in class org.springdoc.core.DelegatingMethodParameter

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

Gets filter.

getFrameworkEndpoints() - Method in interface org.springdoc.core.SecurityOAuth2Provider

Gets framework endpoints.

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

Gets generic map response.

getGenericParameterType() - Method in class org.springdoc.core.DelegatingMethodParameter

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

Gets group.

getGroup() - Method in class org.springdoc.core.SpringDocConfigProperties.GroupConfig

Gets group.

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

Gets group configs.

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

Gets groups.

getGroupsOrder() - Method in class org.springdoc.core.AbstractSwaggerUiConfigProperties

Gets groups order.

getHandlerMethods() - Method in interface org.springdoc.core.SecurityOAuth2Provider

Gets handler methods.

getHeaderName() - Method in class org.springdoc.core.SwaggerUiConfigProperties.Csrf

Gets header name.

getHeaders(MethodAttributes, Map<String, Parameter>) - Static method in class org.springdoc.core.AbstractRequestBuilder

Gets headers.

getHeaders() - Method in class org.springdoc.core.fn.RouterFunctionData

Get headers string [ ].

getHeaders() - Method in class org.springdoc.core.fn.RouterOperation

Get headers string [ ].

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

Gets headers.

getId() - Method in class org.springdoc.api.ErrorMessage

Gets id.

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

Gets json view annotation.

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

Gets json view annotation for request body.

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

Gets layout.

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

Gets mappings map.

getMaxDisplayedTags() - Method in class org.springdoc.core.AbstractSwaggerUiConfigProperties

Gets max displayed tags.

getMember() - Method in class org.springdoc.core.DelegatingMethodParameter

getMergedSchema() - Method in class org.springdoc.core.RequestBodyInfo

Gets merged schema.

getMessage() - Method in class org.springdoc.api.ErrorMessage

Gets message.

getMethod() - Method in class org.springdoc.core.DelegatingMethodParameter

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

Get method consumes string [ ].

getMethodParameter() - Method in class org.springdoc.core.ParameterInfo

Gets method parameter.

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

Get method produces string [ ].

getMethods() - Method in interface org.springdoc.core.ActuatorProvider

Gets methods.

getMethods() - Method in class org.springdoc.core.fn.RouterFunctionData

Get methods request method [ ].

getMethods() - Method in class org.springdoc.core.fn.RouterOperation

Get methods request method [ ].

getName() - Method in class org.springdoc.core.AbstractSwaggerUiConfigProperties.SwaggerUrl

Gets name.

getNestedGenericParameterType() - Method in class org.springdoc.core.DelegatingMethodParameter

getNestedParameterType() - Method in class org.springdoc.core.DelegatingMethodParameter

getOauth2RedirectUrl() - Method in class org.springdoc.core.AbstractSwaggerUiConfigProperties

Gets oauth 2 redirect url.

getOpenApi() - Method in class org.springdoc.api.AbstractOpenApiResource

Gets open api.

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

Gets open api customisers.

getOperation() - Method in class org.springdoc.core.fn.RouterOperation

Gets operation.

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

Gets operation customizers.

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

Gets operation id.

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

Gets operation id.

getOperationModel() - Method in class org.springdoc.core.fn.RouterOperation

Gets operation model.

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

Gets operations sorter.

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

Gets packages to exclude.

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

Gets packages to exclude.

getPackagesToExclude() - Method in class org.springdoc.core.SpringDocConfigProperties.GroupConfig

Gets packages to exclude.

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

Gets packages to scan.

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

Gets packages to scan.

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

Gets packages to scan.

getPage() - Method in class org.springdoc.core.converters.models.Pageable

Gets page.

getParameter() - Method in class org.springdoc.core.ParameterInfo

Gets parameter.

getParameterAnnotations() - Method in class org.springdoc.core.DelegatingMethodParameter

getParameterModel() - Method in class org.springdoc.core.ParameterInfo

Gets parameter model.

getParameterName() - Method in class org.springdoc.core.DelegatingMethodParameter

getParameterType() - Method in class org.springdoc.core.DelegatingMethodParameter

getParameterTypes() - Method in class org.springdoc.core.fn.RouterOperation

Get parameter types class [ ].

getPath() - Method in class org.springdoc.core.AbstractSwaggerUiConfigProperties

Gets path.

getPath() - Method in class org.springdoc.core.fn.RouterFunctionData

Gets path.

getPath() - Method in class org.springdoc.core.fn.RouterOperation

Gets path.

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

Gets path.

getPaths(Map<String, Object>) - Method in class org.springdoc.api.AbstractOpenApiResource

Gets paths.

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

Gets paths to exclude.

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

Gets paths to exclude.

getPathsToExclude() - Method in class org.springdoc.core.SpringDocConfigProperties.GroupConfig

Gets paths to exclude.

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

Gets paths to match.

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

Gets paths to match.

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

Gets paths to match.

getPathVar() - Method in class org.springdoc.core.ParameterInfo

Gets path var.

getpName() - Method in class org.springdoc.core.ParameterInfo

Gets name.

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

Gets prefix.

getProduces() - Method in class org.springdoc.core.fn.RouterFunctionData

Get produces string [ ].

getProduces() - Method in class org.springdoc.core.fn.RouterOperation

Get produces string [ ].

getQueryParams() - Method in class org.springdoc.core.fn.RouterFunctionData

Gets query params.

getQueryParams() - Method in class org.springdoc.core.fn.RouterOperation

Gets query params.

getRealm() - Method in class org.springdoc.core.SwaggerUiOAuthProperties

Gets realm.

getReplacement(Class) - Static method in class org.springdoc.core.converters.AdditionalModelsConverter

Gets replacement.

getRequestBody() - Method in class org.springdoc.core.RequestBodyInfo

Gets request body.

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

Gets request body builder.

getRequestHeader() - Method in class org.springdoc.core.ParameterInfo

Gets request header.

getRequestParam() - Method in class org.springdoc.core.ParameterInfo

Gets request param.

getResolvedType(ResolvableType, Class<?>) - Static method in interface org.springdoc.core.ReturnTypeParser

Gets resolved type.

getReturnType(MethodParameter) - Method in interface org.springdoc.core.ReturnTypeParser

Gets return type.

getRouterFunctionDatas() - Method in class org.springdoc.core.fn.AbstractRouterFunctionVisitor

Gets router function datas.

getRouterFunctionPaths(String, AbstractRouterFunctionVisitor) - Method in class org.springdoc.api.AbstractOpenApiResource

Gets router function paths.

getRouterOperations(OpenAPI) - Method in interface org.springdoc.core.RepositoryRestResourceProvider

Gets router operations.

getScopes() - Method in class org.springdoc.core.SwaggerUiOAuthProperties

Get the pre-selected scopes during authentication.

getScopeSeparator() - Method in class org.springdoc.core.SwaggerUiOAuthProperties

Gets scope separator.

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

getSecurityRequirements(HandlerMethod) - Method in class org.springdoc.core.SecurityParser

Get security requirements io .

getSecurityRequirements(SecurityRequirement[]) - Method in class org.springdoc.core.SecurityParser

Gets security requirements.

getSecurityRequirementsForClass(Class<?>) - Method in class org.springdoc.core.SecurityParser

getSecurityScheme(SecurityScheme) - Method in class org.springdoc.core.SecurityParser

Gets security scheme.

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

Gets show common extensions.

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

Gets show extensions.

getSize() - Method in class org.springdoc.core.converters.models.Pageable

Gets size.

getSort() - Method in class org.springdoc.core.converters.models.Pageable

Gets sort.

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

Gets supported submit methods.

getTag() - Method in interface org.springdoc.core.ActuatorProvider

Gets tag.

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

Gets tags sorter.

getType(MethodParameter) - Static method in interface org.springdoc.core.ReturnTypeParser

Gets type.

getUiRootPath() - Method in class org.springdoc.core.SwaggerUiConfigParameters

Gets ui root path.

getUriComponentsBuilder(String) - Method in class org.springdoc.ui.AbstractSwaggerWelcome

Gets uri components builder.

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

Gets url.

getUrl() - Method in class org.springdoc.core.AbstractSwaggerUiConfigProperties.SwaggerUrl

Gets url.

getUrls() - Method in class org.springdoc.core.AbstractSwaggerUiConfigProperties

Gets urls.

getUrlsPrimaryName() - Method in class org.springdoc.core.AbstractSwaggerUiConfigProperties

Gets urls primary name.

getUseBasicAuthenticationWithAccessCodeGrant() - Method in class org.springdoc.core.SwaggerUiOAuthProperties

Gets use basic authentication with access code grant.

getUsePkceWithAuthorizationCodeGrant() - Method in class org.springdoc.core.SwaggerUiOAuthProperties

Gets use pkce with authorization code grant.

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

Gets validator url.

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

Gets webjars.

getYamlMapper() - Method in class org.springdoc.api.AbstractOpenApiResource

Gets yaml mapper.

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

The constant GRACEFUL_EXCEPTION_OCCURRED.

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

Group builder.

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

The constant GROUP_CONFIG_FIRST_PROPERTY.

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

The constant GROUP_NAME_NOT_NULL.

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

Instantiates a new Group config.

GroupConfig(String, List<String>, List<String>, List<String>, List<String>) - Constructor for class org.springdoc.core.SpringDocConfigProperties.GroupConfig

Instantiates a new Group config.

GroupedOpenApi - Class in org.springdoc.core

The type Grouped open api.

GroupedOpenApi.Builder - Class in org.springdoc.core

The type Builder.

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

groupsOrder - Variable in class org.springdoc.core.AbstractSwaggerUiConfigProperties

The Groups order.

H

hasDefaultTransformations() - Method in class org.springdoc.ui.AbstractSwaggerIndexTransformer

Has default transformations boolean.

hashCode() - Method in class org.springdoc.core.AbstractSwaggerUiConfigProperties.SwaggerUrl

hashCode() - Method in class org.springdoc.core.converters.models.Pageable

hashCode() - Method in class org.springdoc.core.DelegatingMethodParameter

hashCode() - Method in class org.springdoc.core.fn.RouterOperation

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

The constant HEAD_METHOD.

header(String, String) - Method in class org.springdoc.core.fn.AbstractRouterFunctionVisitor

Header.

I

initBeanFactoryPostProcessor(ConfigurableListableBeanFactory) - Static method in class org.springdoc.core.SpringdocBeanFactoryConfigurer

Init bean factory post processor.

initOpenAPIBuilder() - Method in class org.springdoc.api.AbstractOpenApiResource

Init open api builder.

initParameterNameDiscovery(ParameterNameDiscoverer) - Method in class org.springdoc.core.DelegatingMethodParameter

isAdditionalRestController(Class<?>) - Method in class org.springdoc.api.AbstractOpenApiResource

Is additional rest controller boolean.

isAnnotationToIgnore(MethodParameter) - Static method in class org.springdoc.core.SpringDocAnnotationsUtils

Is annotation to ignore boolean.

isAnnotationToIgnore(Type) - Static method in class org.springdoc.core.SpringDocAnnotationsUtils

Is annotation to ignore boolean.

isAutoTagClasses(Operation) - Method in class org.springdoc.core.OpenAPIBuilder

Is auto tag classes boolean.

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

Is auto tag classes boolean.

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

Is cache disabled boolean.

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

Is csrf enabled boolean.

isDeprecated(AnnotatedElement) - Static method in class org.springdoc.core.converters.SchemaPropertyDeprecatingConverter

Is deprecated boolean.

isDisabled() - Method in class org.springdoc.core.SpringDocConfigProperties.Cache

Is disabled boolean.

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

Is disable swagger default url boolean.

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

Is display query params boolean.

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

Is display query params without oauth 2 boolean.

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

Is enabled boolean.

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

Is enabled boolean.

isEnabled() - Method in class org.springdoc.core.SpringDocConfigProperties.ModelConverters.DeprecatingConverter

Is enabled boolean.

isEnabled() - Method in class org.springdoc.core.SwaggerUiConfigProperties.Csrf

Is enabled boolean.

isFile(Class) - Static method in class org.springdoc.core.GenericParameterBuilder

Is file boolean.

isFile(MethodParameter) - Method in class org.springdoc.core.GenericParameterBuilder

Is file boolean.

isFluxTypeWrapper(Class<?>) - Static method in class org.springdoc.core.converters.ConverterUtils

Is flux type wrapper boolean.

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

Is hidden boolean.

isHiddenRestControllers(Class<?>) - Static method in class org.springdoc.api.AbstractOpenApiResource

Is hidden rest controllers boolean.

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

Is method overloaded boolean.

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

Is model and view allowed boolean.

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

Is no api response doc boolean.

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

Is override with generic response boolean.

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

Is package to scan boolean.

isParameterObject() - Method in class org.springdoc.core.DelegatingMethodParameter

Is parameter object boolean.

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

Is param to ignore boolean.

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

Is path to match boolean.

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

Is remove broken reference definitions boolean.

isRequestTypeToIgnore(Class<?>) - Static method in class org.springdoc.core.AbstractRequestBuilder

Is request type to ignore boolean.

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

Is resolve schema properties boolean.

isResponseTypeToIgnore(Class<?>) - Static method in class org.springdoc.core.converters.ConverterUtils

Is response type to ignore boolean.

isResponseTypeWrapper(Class<?>) - Static method in class org.springdoc.core.converters.ConverterUtils

Is response type wrapper boolean.

isRestController(String, Class<?>) - Method in interface org.springdoc.core.ActuatorProvider

Is rest controller boolean.

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

Is show actuator boolean.

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

Is show login endpoint boolean.

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

Is use fqn boolean.

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

Is valid parameter boolean.

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

Is valid url boolean.

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

Is with response body schema doc boolean.

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

Is writer with default pretty printer boolean.

L

layout - Variable in class org.springdoc.core.AbstractSwaggerUiConfigProperties

The name of a component available via the plugin system to use as the top-level layout for Swagger UI.

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

The constant LAYOUT_PROPERTY.

M

maxDisplayedTags - Variable in class org.springdoc.core.AbstractSwaggerUiConfigProperties

If set, limits the number of tagged operations displayed to at most this many.

mergeOperation(Operation, Operation) - Method in class org.springdoc.core.OperationBuilder

Merge operation operation.

mergeParameter(List<Parameter>, Parameter) - Static method in class org.springdoc.core.GenericParameterBuilder

Merge parameter parameter.

mergeRouters(List<RouterFunctionData>, List<RouterOperation>) - Method in class org.springdoc.api.AbstractOpenApiResource

Merge routers.

mergeSchema(Content, Schema<?>, String) - Static method in class org.springdoc.core.SpringDocAnnotationsUtils

Merge schema.

method(Set<HttpMethod>) - Method in class org.springdoc.core.fn.AbstractRouterFunctionVisitor

Method.

MethodAttributes - Class in org.springdoc.core

The type Method attributes.

MethodAttributes(String[], String, String, Map<String, ApiResponse>) - Constructor for class org.springdoc.core.MethodAttributes

Instantiates a new Method attributes.

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

Instantiates a new Method attributes.

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

Instantiates a new Method attributes.

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

Instantiates a new Model converter registrar.

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

MonetaryAmount - Class in org.springdoc.core.converters.models

The type Monetary amount.

MonetaryAmount() - Constructor for class org.springdoc.core.converters.models.MonetaryAmount

MultipleOpenApiSupportCondition - Class in org.springdoc.core

The type Multiple open api support condition.

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

The constant MVC_SERVLET_PATH.

N

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

The constant NULL.

O

OAUTH2_REDIRECT_URL_PROPERTY - Static variable in class org.springdoc.core.SwaggerUiConfigParameters

The constant OAUTH2_REDIRECT_URL_PROPERTY.

oauth2RedirectUrl - Variable in class org.springdoc.core.AbstractSwaggerUiConfigProperties

OAuth redirect URL.

objectMapper - Variable in class org.springdoc.ui.AbstractSwaggerIndexTransformer

The Object mapper.

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

The constant OPENAPI_ARRAY_TYPE.

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

The constant OPENAPI_STRING_TYPE.

openAPIBuilder - Variable in class org.springdoc.api.AbstractOpenApiResource

The Open api builder.

OpenAPIBuilder - Class in org.springdoc.core

The type Open api builder.

OpenApiBuilderCustomiser - Interface in org.springdoc.core.customizers

The interface Open api builder customiser.

OpenApiCustomiser - Interface in org.springdoc.core.customizers

The interface Open api customiser.

OpenApiResourceNotFoundException - Exception in org.springdoc.api

The type Open api resource not found exception.

OpenApiResourceNotFoundException(String) - Constructor for exception org.springdoc.api.OpenApiResourceNotFoundException

Instantiates a new Open api resource not found exception.

OperationBuilder - Class in org.springdoc.core

The type Operation builder.

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

Instantiates a new Operation builder.

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

operationsSorter - Variable in class org.springdoc.core.AbstractSwaggerUiConfigProperties

Apply a sort to the operation list of each API

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

The constant OPTIONS_METHOD.

or() - Method in class org.springdoc.core.fn.AbstractRouterFunctionVisitor

Or.

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

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

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

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

org.springdoc.core.fn - package org.springdoc.core.fn

org.springdoc.ui - package org.springdoc.ui

overwriteSwaggerDefaultUrl(String) - Method in class org.springdoc.ui.AbstractSwaggerIndexTransformer

Overwrite swagger default url string.

P

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

Packages to exclude builder.

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

Packages to scan builder.

Pageable - Class in org.springdoc.core.converters.models

The type Pageable.

Pageable(int, int, List<String>) - Constructor for class org.springdoc.core.converters.models.Pageable

Instantiates a new Pageable.

PageableAsQueryParam - Annotation Type in org.springdoc.core.converters.models

The interface Pageable as query param.

param(String, String) - Method in class org.springdoc.core.fn.AbstractRouterFunctionVisitor

Param.

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

ParameterInfo - Class in org.springdoc.core

The type Parameter info.

ParameterInfo(String, MethodParameter) - Constructor for class org.springdoc.core.ParameterInfo

Instantiates a new Parameter info.

ParameterObject - Annotation Type in org.springdoc.api.annotations

The interface Parameter object.

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

Parse open api.

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

The constant PATCH_METHOD.

path - Variable in class org.springdoc.core.AbstractSwaggerUiConfigProperties

The path for the Swagger UI pages to load.

path(String) - Method in class org.springdoc.core.fn.AbstractRouterFunctionVisitor

Path.

pathExtension(String) - Method in class org.springdoc.core.fn.AbstractRouterFunctionVisitor

Path extension.

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

Paths to exclude builder.

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

Paths to match builder.

PolymorphicModelConverter - Class in org.springdoc.core.converters

The type Polymorphic model converter.

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

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

The constant POST_METHOD.

postProcessBeanFactory(ConfigurableListableBeanFactory) - Method in class org.springdoc.core.SpringdocBeanFactoryConfigurer

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

The type Property customizing converter.

PropertyCustomizingConverter(Optional<List<PropertyCustomizer>>) - Constructor for class org.springdoc.core.converters.PropertyCustomizingConverter

Instantiates a new Property customizing converter.

PropertyResolverUtils - Class in org.springdoc.core

The type Property resolver utils.

PropertyResolverUtils(ConfigurableBeanFactory) - Constructor for class org.springdoc.core.PropertyResolverUtils

Instantiates a new Property resolver utils.

put(String, List<String>, Map<String, Object>) - Static method in interface org.springdoc.core.SpringDocPropertiesUtils

Put.

put(String, Integer, Map<String, Object>) - Static method in interface org.springdoc.core.SpringDocPropertiesUtils

Put.

put(String, Boolean, Map<String, Object>) - Static method in interface org.springdoc.core.SpringDocPropertiesUtils

Put.

put(String, String, Map<String, Object>) - Static method in interface org.springdoc.core.SpringDocPropertiesUtils

Put.

put(String, Map<String, String>, Map<String, Object>) - Static method in interface org.springdoc.core.SpringDocPropertiesUtils

Put.

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

The constant PUT_METHOD.

Q

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

The constant QUERY_PARAM.

queryParam(String, String) - Method in class org.springdoc.core.fn.AbstractRouterFunctionVisitor

Query param.

R

readFullyAsString(InputStream) - Method in class org.springdoc.ui.AbstractSwaggerIndexTransformer

Read fully as string string.

removeAnnotationsToIgnore(Class<?>...) - Static method in class org.springdoc.core.SpringDocAnnotationsUtils

Remove annotations to ignore.

removeAnnotationsToIgnore(Class<?>...) - Method in class org.springdoc.core.SpringDocUtils

Remove annotations to ignore spring doc utils.

removeFluxWrapperToIgnore(Class<?>) - Static method in class org.springdoc.core.converters.ConverterUtils

Remove flux wrapper to ignore.

removeFluxWrapperToIgnore(Class<?>) - Method in class org.springdoc.core.SpringDocUtils

Remove flux wrapper to ignore spring doc utils.

removeRequestWrapperToIgnore(Class<?>...) - Static method in class org.springdoc.core.AbstractRequestBuilder

Remove request wrapper to ignore.

removeRequestWrapperToIgnore(Class<?>...) - Method in class org.springdoc.core.SpringDocUtils

Remove request wrapper to ignore spring doc utils.

removeResponseTypeToIgnore(Class<?>) - Static method in class org.springdoc.core.converters.ConverterUtils

Remove response type to ignore.

removeResponseTypeToIgnore(Class<?>) - Method in class org.springdoc.core.SpringDocUtils

Remove response type to ignore spring doc utils.

removeResponseWrapperToIgnore(Class<?>) - Static method in class org.springdoc.core.converters.ConverterUtils

Remove response wrapper to ignore.

removeResponseWrapperToIgnore(Class<?>) - Method in class org.springdoc.core.SpringDocUtils

Remove response wrapper to ignore spring doc utils.

removeSimpleTypesForParameterObject(Class<?>...) - Method in class org.springdoc.core.SpringDocUtils

Remove simple types for parameter object spring doc utils.

replaceWithClass(Class, Class) - Static method in class org.springdoc.core.converters.AdditionalModelsConverter

Replace with class.

replaceWithClass(Class, Class) - Method in class org.springdoc.core.SpringDocUtils

Replace with class spring doc utils.

replaceWithSchema(Class, Schema) - Static method in class org.springdoc.core.converters.AdditionalModelsConverter

Replace with schema.

replaceWithSchema(Class, Schema) - Method in class org.springdoc.core.SpringDocUtils

Replace with schema spring doc utils.

RepositoryRestResourceProvider - Interface in org.springdoc.core

The interface Repository rest resource provider.

RequestBodyBuilder - Class in org.springdoc.core

The type Request body builder.

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

Instantiates a new Request body builder.

RequestBodyInfo - Class in org.springdoc.core

The type Request body info.

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

RequestInfo - Class in org.springdoc.core

The type Request info.

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

Instantiates a new Request info.

RequestTypeToIgnoreConverter - Class in org.springdoc.core.converters

The type Request type to ignore converter.

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

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

Required boolean.

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

Reset calculated open api.

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.FileSupportConverter

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

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(AnnotatedType, ModelConverterContext, Iterator<ModelConverter>) - Method in class org.springdoc.core.converters.SchemaPropertyDeprecatingConverter

resolve(String) - Method in class org.springdoc.core.PropertyResolverUtils

Resolve string.

resolveProperties(Schema, PropertyResolverUtils) - Method in class org.springdoc.core.OpenAPIBuilder

Resolve properties schema.

resolveSchemaFromType(Class<?>, Components, JsonView, Annotation[]) - Static method in class org.springdoc.core.SpringDocAnnotationsUtils

Resolve schema from type schema.

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.

resolveType(ResolvableType[], Class<?>) - Static method in interface org.springdoc.core.ReturnTypeParser

Resolve type.

resolveVariable(TypeVariable<?>, ResolvableType) - Static method in interface org.springdoc.core.ReturnTypeParser

Resolve variable resolvable type.

ResponseSupportConverter - Class in org.springdoc.core.converters

The type Response support converter.

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

ReturnTypeParser - Interface in org.springdoc.core

The interface Return type parser.

routerFunctionData - Variable in class org.springdoc.core.fn.AbstractRouterFunctionVisitor

The Router function data.

RouterFunctionData - Class in org.springdoc.core.fn

The type Router function data.

RouterFunctionData() - Constructor for class org.springdoc.core.fn.RouterFunctionData

routerFunctionDatas - Variable in class org.springdoc.core.fn.AbstractRouterFunctionVisitor

The Router function datas.

RouterOperation - Annotation Type in org.springdoc.core.annotations

The annotation may be used to define a single Router Operation as an OpenAPI Operation, and/or to define additional properties using @Operation annotation.

RouterOperation - Class in org.springdoc.core.fn

The type Router operation.

RouterOperation(RouterOperation) - Constructor for class org.springdoc.core.fn.RouterOperation

Instantiates a new Router operation.

RouterOperation(RouterOperation, RouterFunctionData) - Constructor for class org.springdoc.core.fn.RouterOperation

Instantiates a new Router operation.

RouterOperation(String, RequestMethod[]) - Constructor for class org.springdoc.core.fn.RouterOperation

Instantiates a new Router operation.

RouterOperations - Annotation Type in org.springdoc.core.annotations

Container for repeatable RouterOperation annotation

S

SchemaPropertyDeprecatingConverter - Class in org.springdoc.core.converters

The type Schema property deprecating converter.

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

SecurityOAuth2Provider - Interface in org.springdoc.core

The interface Security o auth 2 provider.

SecurityParser - Class in org.springdoc.core

The type Security parser.

SecurityParser(PropertyResolverUtils) - Constructor for class org.springdoc.core.SecurityParser

Instantiates a new Security parser.

setAdditionalQueryStringParams(Map<String, String>) - Method in class org.springdoc.core.SwaggerUiOAuthProperties

Sets additional query string params.

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

Sets api docs.

setAppName(String) - Method in class org.springdoc.core.SwaggerUiOAuthProperties

Sets app name.

setAutoTagClasses(boolean) - Method in class org.springdoc.core.SpringDocConfigProperties

Sets auto tag classes.

setBeanClass(Class<?>) - Method in class org.springdoc.core.fn.RouterOperation

Sets bean class.

setBeanMethod(String) - Method in class org.springdoc.core.fn.RouterOperation

Sets bean method.

setCache(SpringDocConfigProperties.Cache) - Method in class org.springdoc.core.SpringDocConfigProperties

Sets cache.

setCachedOpenAPI(OpenAPI) - Method in class org.springdoc.core.OpenAPIBuilder

Sets cached open api.

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

Sets class consumes.

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

Sets class produces.

setClientId(String) - Method in class org.springdoc.core.SwaggerUiOAuthProperties

Sets client id.

setClientSecret(String) - Method in class org.springdoc.core.SwaggerUiOAuthProperties

Sets client secret.

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

Sets config url.

setConsumes(String[]) - Method in class org.springdoc.core.fn.RouterOperation

Sets consumes.

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

Sets cookie name.

setCsrf(SwaggerUiConfigProperties.Csrf) - Method in class org.springdoc.core.SwaggerUiConfigProperties

Sets csrf.

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

Sets deep linking.

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

Sets default consumes media type.

setDefaultModelExpandDepth(Integer) - Method in class org.springdoc.core.AbstractSwaggerUiConfigProperties

Sets default model expand depth.

setDefaultModelRendering(String) - Method in class org.springdoc.core.AbstractSwaggerUiConfigProperties

Sets default model rendering.

setDefaultModelsExpandDepth(Integer) - Method in class org.springdoc.core.AbstractSwaggerUiConfigProperties

Sets default models expand depth.

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

Sets default produces media type.

setDeprecatingConverter(SpringDocConfigProperties.ModelConverters.DeprecatingConverter) - Method in class org.springdoc.core.SpringDocConfigProperties.ModelConverters

Sets deprecating converter.

setDescription(String, ApiResponse) - Static method in class org.springdoc.core.GenericResponseBuilder

Sets description.

setDisabled(boolean) - Method in class org.springdoc.core.SpringDocConfigProperties.Cache

Sets disabled.

setDisableSwaggerDefaultUrl(boolean) - Method in class org.springdoc.core.SwaggerUiConfigProperties

Sets disable swagger default url.

setDisplayOperationId(Boolean) - Method in class org.springdoc.core.AbstractSwaggerUiConfigProperties

Sets display operation id.

setDisplayQueryParams(boolean) - Method in class org.springdoc.core.SwaggerUiConfigProperties

Sets display query params.

setDisplayQueryParamsWithoutOauth2(boolean) - Method in class org.springdoc.core.SwaggerUiConfigProperties

Sets display query params without oauth 2.

setDisplayRequestDuration(Boolean) - Method in class org.springdoc.core.AbstractSwaggerUiConfigProperties

Sets display request duration.

setDocExpansion(String) - Method in class org.springdoc.core.AbstractSwaggerUiConfigProperties

Sets doc expansion.

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

Sets enabled.

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

Sets enabled.

setEnabled(boolean) - Method in class org.springdoc.core.SpringDocConfigProperties.ModelConverters.DeprecatingConverter

Sets enabled.

setEnabled(boolean) - Method in class org.springdoc.core.SwaggerUiConfigProperties.Csrf

Sets enabled.

setEnvironment(Environment) - Method in class org.springdoc.core.SpringdocBeanFactoryConfigurer

setFilter(String) - Method in class org.springdoc.core.AbstractSwaggerUiConfigProperties

Sets filter.

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

Deprecated.

Since v1.4.0, GroupedOpenApi.setGroup is marked as deprecated. Use GroupedOpenApi.Builder.group(String) instead. will be removed with v1.5.0

setGroup(String) - Method in class org.springdoc.core.SpringDocConfigProperties.GroupConfig

Sets group.

setGroupConfigs(List<SpringDocConfigProperties.GroupConfig>) - Method in class org.springdoc.core.SpringDocConfigProperties

Sets group configs.

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

Sets groups.

setGroupsOrder(AbstractSwaggerUiConfigProperties.Direction) - Method in class org.springdoc.core.AbstractSwaggerUiConfigProperties

Sets groups order.

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

Sets header name.

setHeaders(String[]) - Method in class org.springdoc.core.fn.RouterOperation

Sets headers.

setId(UUID) - Method in class org.springdoc.api.ErrorMessage

Sets id.

setJsonViewAnnotation(JsonView) - Method in class org.springdoc.core.MethodAttributes

Sets json view annotation.

setJsonViewAnnotationForRequestBody(JsonView) - Method in class org.springdoc.core.MethodAttributes

Sets json view annotation for request body.

setLayout(String) - Method in class org.springdoc.core.AbstractSwaggerUiConfigProperties

Sets layout.

setMaxDisplayedTags(Integer) - Method in class org.springdoc.core.AbstractSwaggerUiConfigProperties

Sets max displayed tags.

setMergedSchema(Schema) - Method in class org.springdoc.core.RequestBodyInfo

Sets merged schema.

setMessage(String) - Method in class org.springdoc.api.ErrorMessage

Sets message.

setMethodOverloaded(boolean) - Method in class org.springdoc.core.MethodAttributes

Sets method overloaded.

setMethods(Set<HttpMethod>) - Method in class org.springdoc.core.fn.RouterFunctionData

Sets methods.

setMethods(RequestMethod[]) - Method in class org.springdoc.core.fn.RouterOperation

Sets methods.

setModelAndViewAllowed(boolean) - Method in class org.springdoc.core.SpringDocConfigProperties

Sets model and view allowed.

setName(String) - Method in class org.springdoc.core.AbstractSwaggerUiConfigProperties.SwaggerUrl

Sets name.

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

Sets oauth 2 redirect url.

setOperation(Operation) - Method in class org.springdoc.core.fn.RouterOperation

Sets operation.

setOperationModel(Operation) - Method in class org.springdoc.core.fn.RouterOperation

Sets operation model.

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

Sets operations sorter.

setOverrideWithGenericResponse(boolean) - Method in class org.springdoc.core.SpringDocConfigProperties

Sets override with generic response.

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

Sets packages to exclude.

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

Sets packages to exclude.

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

Sets packages to scan.

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

Sets packages to scan.

setPage(Integer) - Method in class org.springdoc.core.converters.models.Pageable

Sets page.

setParameterModel(Parameter) - Method in class org.springdoc.core.ParameterInfo

Sets parameter model.

setParameterTypes(Class<?>[]) - Method in class org.springdoc.core.fn.RouterOperation

Sets parameter types.

setPath(String) - Method in class org.springdoc.core.AbstractSwaggerUiConfigProperties

Sets path.

setPath(String) - Method in class org.springdoc.core.fn.RouterFunctionData

Sets path.

setPath(String) - Method in class org.springdoc.core.fn.RouterOperation

Sets path.

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

Sets path.

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

Sets paths to exclude.

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

Sets paths to exclude.

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

Sets paths to match.

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

Sets paths to match.

setpName(String) - Method in class org.springdoc.core.ParameterInfo

Sets name.

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

Sets prefix.

setProduces(String[]) - Method in class org.springdoc.core.fn.RouterOperation

Sets produces.

setQueryParams(Map<String, String>) - Method in class org.springdoc.core.fn.RouterOperation

Sets query params.

setRealm(String) - Method in class org.springdoc.core.SwaggerUiOAuthProperties

Sets realm.

setRemoveBrokenReferenceDefinitions(boolean) - Method in class org.springdoc.core.SpringDocConfigProperties

Sets remove broken reference definitions.

setRequestBody(RequestBody) - Method in class org.springdoc.core.RequestBodyInfo

Sets request body.

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

Sets resolve schema properties.

setScopes(List<String>) - Method in class org.springdoc.core.SwaggerUiOAuthProperties

Sets the pre-selected scopes during authentication.

setScopeSeparator(String) - Method in class org.springdoc.core.SwaggerUiOAuthProperties

Sets scope separator.

setServerBaseUrl(String) - Method in class org.springdoc.core.OpenAPIBuilder

Sets server base url.

setServersPresent(boolean) - Method in class org.springdoc.core.OpenAPIBuilder

Sets servers present.

setShowActuator(boolean) - Method in class org.springdoc.core.SpringDocConfigProperties

Sets show actuator.

setShowCommonExtensions(Boolean) - Method in class org.springdoc.core.AbstractSwaggerUiConfigProperties

Sets show common extensions.

setShowExtensions(Boolean) - Method in class org.springdoc.core.AbstractSwaggerUiConfigProperties

Sets show extensions.

setShowLoginEndpoint(boolean) - Method in class org.springdoc.core.SpringDocConfigProperties

Sets show login endpoint.

setSize(Integer) - Method in class org.springdoc.core.converters.models.Pageable

Sets size.

setSort(List<String>) - Method in class org.springdoc.core.converters.models.Pageable

Sets sort.

setSupportedSubmitMethods(List<String>) - Method in class org.springdoc.core.AbstractSwaggerUiConfigProperties

Sets supported submit methods.

setTagsSorter(String) - Method in class org.springdoc.core.AbstractSwaggerUiConfigProperties

Sets tags sorter.

setUiRootPath(String) - Method in class org.springdoc.core.SwaggerUiConfigParameters

Sets ui root path.

setUrl(String) - Method in class org.springdoc.core.AbstractSwaggerUiConfigProperties

Sets url.

setUrl(String) - Method in class org.springdoc.core.AbstractSwaggerUiConfigProperties.SwaggerUrl

Sets url.

setUrls(Set<AbstractSwaggerUiConfigProperties.SwaggerUrl>) - Method in class org.springdoc.core.AbstractSwaggerUiConfigProperties

Sets urls.

setUrlsPrimaryName(String) - Method in class org.springdoc.core.AbstractSwaggerUiConfigProperties

Sets urls primary name.

setUseBasicAuthenticationWithAccessCodeGrant(String) - Method in class org.springdoc.core.SwaggerUiOAuthProperties

Sets use basic authentication with access code grant.

setUseFqn(boolean) - Method in class org.springdoc.core.SpringDocConfigProperties

Sets use fqn.

setUsePkceWithAuthorizationCodeGrant(Boolean) - Method in class org.springdoc.core.SwaggerUiOAuthProperties

Sets use pkce with authorization code grant.

setValidatorUrl(String) - Method in class org.springdoc.core.AbstractSwaggerUiConfigProperties

Sets validator url.

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

Sets webjars.

setWithApiResponseDoc(boolean) - Method in class org.springdoc.core.MethodAttributes

Sets with api response doc.

setWithResponseBodySchemaDoc(boolean) - Method in class org.springdoc.core.MethodAttributes

Sets with response body schema doc.

setWriterWithDefaultPrettyPrinter(boolean) - Method in class org.springdoc.core.SpringDocConfigProperties

Sets writer with default pretty printer.

showCommonExtensions - Variable in class org.springdoc.core.AbstractSwaggerUiConfigProperties

Controls the display of extensions

showExtensions - Variable in class org.springdoc.core.AbstractSwaggerUiConfigProperties

Controls the display of vendor extension (x-) fields and values.

splitCamelCase(String) - Static method in class org.springdoc.core.OpenAPIBuilder

Split camel case string.

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

The constant SPRINGDOC_ACTUATOR_DESCRIPTION.

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

The constant SPRINGDOC_ACTUATOR_DOC_DESCRIPTION.

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

The constant SPRINGDOC_ACTUATOR_DOC_URL.

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

The constant SPRINGDOC_ACTUATOR_TAG.

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

The constant SPRINGDOC_CACHE_DISABLED.

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

The constant SPRINGDOC_DEPRECATING_CONVERTER_ENABLED.

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

The constant SPRINGDOC_ENABLED.

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

The constant SPRINGDOC_PREFIX.

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

The constant SPRINGDOC_SCHEMA_RESOLVE_PROPERTIES.

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

The constant SPRINGDOC_SHOW_ACTUATOR.

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

The constant SPRINGDOC_SHOW_LOGIN_ENDPOINT.

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

The constant SPRINGDOC_SWAGGER_UI_ENABLED.

SpringDocAnnotationsUtils - Class in org.springdoc.core

The type Spring doc annotations utils.

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

SpringdocBeanFactoryConfigurer - Class in org.springdoc.core

The type Springdoc bean factory configurer.

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

springDocConfigProperties - Variable in class org.springdoc.api.AbstractOpenApiResource

The Spring doc config properties.

SpringDocConfigProperties - Class in org.springdoc.core

The type Spring doc config properties.

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

springDocConfigProperties - Variable in class org.springdoc.ui.AbstractSwaggerWelcome

The Spring doc config properties.

SpringDocConfigProperties.ApiDocs - Class in org.springdoc.core

The type Api docs.

SpringDocConfigProperties.Cache - Class in org.springdoc.core

The type Cache.

SpringDocConfigProperties.GroupConfig - Class in org.springdoc.core

The type Group config.

SpringDocConfigProperties.Groups - Class in org.springdoc.core

The type Groups.

SpringDocConfigProperties.ModelConverters - Class in org.springdoc.core

The type Model converters.

SpringDocConfigProperties.ModelConverters.DeprecatingConverter - Class in org.springdoc.core

The type Deprecating converter.

SpringDocConfigProperties.Webjars - Class in org.springdoc.core

The type Webjars.

SpringDocConfiguration - Class in org.springdoc.core

The type Spring doc configuration.

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

SpringDocPropertiesUtils - Interface in org.springdoc.core

The interface Spring doc properties utils.

SpringDocUIException - Exception in org.springdoc.ui

The type Spring doc ui exception.

SpringDocUIException(String, Throwable) - Constructor for exception org.springdoc.ui.SpringDocUIException

Instantiates a new Spring doc ui exception.

SpringDocUtils - Class in org.springdoc.core

The type Spring doc utils.

startAnd() - Method in class org.springdoc.core.fn.AbstractRouterFunctionVisitor

Start and.

startNegate() - Method in class org.springdoc.core.fn.AbstractRouterFunctionVisitor

Start negate.

startOr() - Method in class org.springdoc.core.fn.AbstractRouterFunctionVisitor

Start or.

supportedSubmitMethods - Variable in class org.springdoc.core.AbstractSwaggerUiConfigProperties

The supported try it out methods

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

The constant SWAGGER_CONFIG_URL.

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

The constant SWAGGER_UI_DEFAULT_URL.

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

The constant SWAGGER_UI_OAUTH_REDIRECT_URL.

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

The constant SWAGGER_UI_PATH.

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

The constant SWAGGER_UI_URL.

swaggerUiConfig - Variable in class org.springdoc.ui.AbstractSwaggerIndexTransformer

The Swagger ui config.

swaggerUiConfig - Variable in class org.springdoc.ui.AbstractSwaggerWelcome

The Swagger ui configuration.

SwaggerUiConfigParameters - Class in org.springdoc.core

The type Swagger ui config parameters.

SwaggerUiConfigParameters(SwaggerUiConfigProperties) - Constructor for class org.springdoc.core.SwaggerUiConfigParameters

Instantiates a new Swagger ui config parameters.

swaggerUiConfigParameters - Variable in class org.springdoc.ui.AbstractSwaggerWelcome

The Swagger ui calculated config.

SwaggerUiConfigProperties - Class in org.springdoc.core

The type Swagger ui config properties.

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

SwaggerUiConfigProperties.Csrf - Class in org.springdoc.core

The type Csrf.

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

The Swagger ui o auth properties.

SwaggerUrl() - Constructor for class org.springdoc.core.AbstractSwaggerUiConfigProperties.SwaggerUrl

Instantiates a new Swagger url.

SwaggerUrl(String, String) - Constructor for class org.springdoc.core.AbstractSwaggerUiConfigProperties.SwaggerUrl

Instantiates a new Swagger url.

SwaggerUrl(String) - Constructor for class org.springdoc.core.AbstractSwaggerUiConfigProperties.SwaggerUrl

Instantiates a new Swagger url.

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

The constant SWAGGGER_CONFIG_FILE.

T

tagsSorter - Variable in class org.springdoc.core.AbstractSwaggerUiConfigProperties

Apply a sort to the tag list of each API

toString() - Method in class org.springdoc.core.AbstractSwaggerUiConfigProperties.SwaggerUrl

toString() - Method in class org.springdoc.core.converters.models.Pageable

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

The constant TRACE_METHOD.

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

Type string.

U

updateServers(OpenAPI) - Method in class org.springdoc.core.OpenAPIBuilder

Update servers open api.

url - Variable in class org.springdoc.core.AbstractSwaggerUiConfigProperties

The Url.

urls - Variable in class org.springdoc.core.AbstractSwaggerUiConfigProperties

The Urls.

URLS_PROPERTY - Static variable in class org.springdoc.core.SwaggerUiConfigParameters

The constant URLS_PROPERTY.

urlsPrimaryName - Variable in class org.springdoc.core.AbstractSwaggerUiConfigProperties

The Urls primary name.

V

validatorUrl - Variable in class org.springdoc.core.AbstractSwaggerUiConfigProperties

URL to validate specs against.

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

Value string.

W

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

withContainingClass(Class<?>) - Method in class org.springdoc.core.DelegatingMethodParameter

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