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

A

AbstractOpenApiResource - Class in org.springdoc.api

The type Abstract open api resource.

AbstractOpenApiResource(String, ObjectFactory<OpenAPIService>, AbstractRequestService, GenericResponseService, OperationService, SpringDocConfigProperties, SpringDocProviders, SpringDocCustomizers) - Constructor for class org.springdoc.api.AbstractOpenApiResource

Instantiates a new Abstract open api resource.

AbstractRequestService - Class in org.springdoc.core

The type Abstract request builder.

AbstractRequestService(GenericParameterService, RequestBodyService, OperationService, Optional<List<ParameterCustomizer>>, LocalVariableTableParameterNameDiscoverer) - Constructor for class org.springdoc.core.AbstractRequestService

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

AbstractSpringdocRouteBuilder - Class in org.springdoc.core.fn

The type Abstract springdoc route builder.

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

AbstractSwaggerIndexTransformer - Class in org.springdoc.ui

The type Abstract swagger index transformer.

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

Instantiates a new Abstract swagger index transformer.

AbstractSwaggerResourceResolver - Class in org.springdoc.ui

The type Web jars version resource resolver.

AbstractSwaggerResourceResolver(SwaggerUiConfigProperties) - Constructor for class org.springdoc.ui.AbstractSwaggerResourceResolver

Instantiates a new Web jars version resource resolver.

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.

accessMode(Schema.AccessMode) - Method in class org.springdoc.core.fn.builders.schema.Builder

Access mode schema builder.

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

The constant ACTUATOR_DEFAULT_GROUP.

ActuatorOpenApiCustomizer - Class in org.springdoc.core.customizers

The type Actuator open api customiser.

ActuatorOpenApiCustomizer(WebEndpointProperties) - Constructor for class org.springdoc.core.customizers.ActuatorOpenApiCustomizer

Instantiates a new Actuator open api customizer.

ActuatorOperationCustomizer - Class in org.springdoc.core.customizers

The type Actuator operation customizer.

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

Instantiates a new Actuator operation customizer.

ActuatorProvider - Class in org.springdoc.core.providers

The type Actuator provider.

ActuatorProvider(Optional<ManagementServerProperties>, Optional<WebEndpointProperties>, ServerProperties, SpringDocConfigProperties) - Constructor for class org.springdoc.core.providers.ActuatorProvider

Instantiates a new Actuator provider.

actuatorWebServer - Variable in class org.springdoc.core.providers.ActuatorProvider

The Actuator web server.

addAllOpenApiCustomizer(Collection<? extends OpenApiCustomiser>) - Method in class org.springdoc.core.GroupedOpenApi

Add all open api customizer grouped open api.

addAllOpenApiMethodFilter(Collection<? extends OpenApiMethodFilter>) - Method in class org.springdoc.core.GroupedOpenApi

Add all open api method filter grouped open api.

addAllOperationCustomizer(Collection<? extends OperationCustomizer>) - Method in class org.springdoc.core.GroupedOpenApi

Add all operation customizer grouped open api.

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.

addAttributes(Map<String, Object>) - Method in class org.springdoc.core.fn.RouterFunctionData

Add attributes.

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

Add consumes.

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

Add consumes.

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

Add csrf string.

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

Add csrf string.

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

Add csrf string from Session storage.

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.

addExtension(String, Object) - Method in interface org.springdoc.api.mixins.SortedOpenAPIMixin

Add extension.

addExtension(String, Object) - Method in interface org.springdoc.api.mixins.SortedOpenAPIMixin31

Add extension.

addExtension(String, Object) - Method in interface org.springdoc.api.mixins.SortedSchemaMixin

Add extension.

addExtension(String, Object) - Method in interface org.springdoc.api.mixins.SortedSchemaMixin31

Add extension.

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

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, String) - Method in class org.springdoc.core.SwaggerUiConfigParameters

Add group.

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(ObjectMapperProvider) - Constructor for class org.springdoc.core.converters.AdditionalModelsConverter

Instantiates a new Additional models converter.

additionalProperties(Schema.AdditionalPropertiesValue) - Method in class org.springdoc.core.fn.builders.schema.Builder

Additional properties builder.

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

Add java type to ignore.

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

Add java type to ignore spring doc utils.

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

Add mappings.

addMethodAdviceInfos(MethodAdviceInfo) - Method in class org.springdoc.core.ControllerAdviceInfo

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

Add open api customiser builder.

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

Add method filter.

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

Add operation customizer builder.

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

Add parameters string.

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

Add params.

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

Add produces.

addProduces(List<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.AbstractRequestService

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.

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

Add router operation customizer builder

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.

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

Add sort.

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

Add syntax highlight string.

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

Add tag.

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

Add url.

afterPropertiesSet() - Method in class org.springdoc.core.customizers.SpringDocCustomizers

afterPropertiesSet() - Method in class org.springdoc.core.providers.WebConversionServiceProvider

afterPropertiesSet() - Method in class org.springdoc.core.SpringDocUIConfiguration

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

The constant ALL_PATTERN.

allOf(Class<?>[]) - Method in class org.springdoc.core.fn.builders.schema.Builder

All of schema builder.

allowableValues(String[]) - Method in class org.springdoc.core.fn.builders.schema.Builder

Allowable values schema builder.

allowableValues(String[]) - Method in class org.springdoc.core.fn.builders.servervariable.Builder

Allowable values server variable builder.

allowEmptyValue(boolean) - Method in class org.springdoc.core.fn.builders.parameter.Builder

Allow empty value parameter builder.

allowReserved(boolean) - Method in class org.springdoc.core.fn.builders.encoding.Builder

Allow reserved encoding builder.

allowReserved(boolean) - Method in class org.springdoc.core.fn.builders.parameter.Builder

Allow reserved parameter builder.

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

And.

anyOf(Class<?>[]) - Method in class org.springdoc.core.fn.builders.schema.Builder

Any of schema builder.

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

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

The Api docs url.

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

The constant APPLICATION_OPENAPI_YAML.

applicationContext - Variable in class org.springdoc.core.providers.SpringWebProvider

The Application context.

applicationWebServer - Variable in class org.springdoc.core.providers.ActuatorProvider

The Application web server.

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

Apply bean validator annotations.

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

Apply bean validator annotations.

array(Builder) - Method in class org.springdoc.core.fn.builders.content.Builder

Array content builder.

array(Builder) - Method in class org.springdoc.core.fn.builders.parameter.Builder

Array parameter builder.

arraySchema(Builder) - Method in class org.springdoc.core.fn.builders.arrayschema.Builder

Array schema array schema builder.

arraySchemaBuilder() - Static method in class org.springdoc.core.fn.builders.arrayschema.Builder

Builder array schema builder.

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

The Attributes.

attributes(Map<String, Object>) - Method in class org.springdoc.core.fn.AbstractRouterFunctionVisitor

Attributes.

B

beanClass(Class<?>) - Method in class org.springdoc.core.fn.builders.operation.Builder

Bean class operation builder.

beanMethod(String) - Method in class org.springdoc.core.fn.builders.operation.Builder

Bean method operation builder.

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

Build operation.

build() - Method in class org.springdoc.core.fn.builders.apiresponse.Builder

Build api response.

build() - Method in class org.springdoc.core.fn.builders.arrayschema.Builder

Build array schema.

build() - Method in class org.springdoc.core.fn.builders.content.Builder

Build content.

build() - Method in class org.springdoc.core.fn.builders.discriminatormapping.Builder

Build discriminator mapping.

build() - Method in class org.springdoc.core.fn.builders.encoding.Builder

Build encoding.

build() - Method in class org.springdoc.core.fn.builders.exampleobject.Builder

Build example object.

build() - Method in class org.springdoc.core.fn.builders.extension.Builder

Build extension.

build() - Method in class org.springdoc.core.fn.builders.extensionproperty.Builder

Build extension property.

build() - Method in class org.springdoc.core.fn.builders.externaldocumentation.Builder

Build external documentation.

build() - Method in class org.springdoc.core.fn.builders.header.Builder

Build header.

build() - Method in class org.springdoc.core.fn.builders.link.Builder

Build link.

build() - Method in class org.springdoc.core.fn.builders.linkparameter.Builder

Build link parameter.

build() - Method in class org.springdoc.core.fn.builders.operation.Builder

Build operation.

build() - Method in class org.springdoc.core.fn.builders.parameter.Builder

Build parameter.

build() - Method in class org.springdoc.core.fn.builders.requestbody.Builder

Build request body.

build() - Method in class org.springdoc.core.fn.builders.schema.Builder

Build schema.

build() - Method in class org.springdoc.core.fn.builders.securityrequirement.Builder

Build security requirement.

build() - Method in class org.springdoc.core.fn.builders.server.Builder

Build server.

build() - Method in class org.springdoc.core.fn.builders.servervariable.Builder

Build server variable.

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

Build api responses.

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

Build grouped open api.

build(Locale) - Method in class org.springdoc.core.OpenAPIService

Build.

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

Build api doc url string.

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

Build callbacks optional.

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

Build config url.

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

Build content content.

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

Build content from doc.

Builder - Class in org.springdoc.core.fn.builders.apiresponse

The type Api response builder.

Builder - Class in org.springdoc.core.fn.builders.arrayschema

The type Array schema builder.

Builder - Class in org.springdoc.core.fn.builders.content

The type Content builder.

Builder - Class in org.springdoc.core.fn.builders.discriminatormapping

The type Discriminator mapping builder.

Builder - Class in org.springdoc.core.fn.builders.encoding

The type Encoding builder.

Builder - Class in org.springdoc.core.fn.builders.exampleobject

The type Example object builder.

Builder - Class in org.springdoc.core.fn.builders.extension

The type Extension builder.

Builder - Class in org.springdoc.core.fn.builders.extensionproperty

The type Extension property builder.

Builder - Class in org.springdoc.core.fn.builders.externaldocumentation

The type External documentation builder.

Builder - Class in org.springdoc.core.fn.builders.header

The type Header builder.

Builder - Class in org.springdoc.core.fn.builders.link

The type Link builder.

Builder - Class in org.springdoc.core.fn.builders.linkparameter

The type Link parameter builder.

Builder - Class in org.springdoc.core.fn.builders.operation

The type Operation builder.

Builder - Class in org.springdoc.core.fn.builders.parameter

The type Parameter builder.

Builder - Class in org.springdoc.core.fn.builders.requestbody

The type Request body builder.

Builder - Class in org.springdoc.core.fn.builders.schema

The type Schema builder.

Builder - Class in org.springdoc.core.fn.builders.securityrequirement

The type Security requirement builder.

Builder - Class in org.springdoc.core.fn.builders.server

The type Server builder.

Builder - Class in org.springdoc.core.fn.builders.servervariable

The type Server variable builder.

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

Builder builder.

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

Build generic response.

buildParam(ParameterInfo, Components, JsonView) - Method in class org.springdoc.core.AbstractRequestService

Build param parameter.

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

Build parameter from doc parameter.

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

Build params parameter.

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

Build request body from doc optional.

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

Build request body from doc optional.

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

Build request body from doc optional.

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

Build request body from doc optional.

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

Build security requirement.

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

Build swagger config url string.

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

Build tags operation.

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

Build tags from class.

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

Build url string.

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

Build swagger ui 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.

calculateHeadersForClass(Class<?>) - Method in class org.springdoc.core.MethodAttributes

Calculate headers for class.

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

Calculate oauth 2 redirect url.

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

Calculate path.

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

Calculate path.

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

Calculate path.

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

Calculate path.

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

Calculate request body info.

calculateUiRootCommon(StringBuilder, StringBuilder[]) - Method in class org.springdoc.ui.AbstractSwaggerWelcome

Calculate ui root common.

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

Calculate ui root path.

changeContainingClass(MethodParameter, Class<?>) - Static method in class org.springdoc.core.DelegatingMethodParameter

Return a variant of this MethodParameter which refers to the given containing class.

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

The constant CLASSPATH_RESOURCE_LOCATION.

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

Clone urls set.

CloudFunctionProvider - Interface in org.springdoc.core.providers

The interface Spring cloud function provider.

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

Compute nested.

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

Common route.

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

Common start nested.

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.

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

Consumes to match builder.

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

Contains deprecated annotation boolean.

containsResponseBody(HandlerMethod) - Static method in class org.springdoc.api.AbstractOpenApiResource

Contains response body boolean.

content(Builder) - Method in class org.springdoc.core.fn.builders.apiresponse.Builder

Content api response builder.

content(Builder) - Method in class org.springdoc.core.fn.builders.parameter.Builder

Content parameter builder.

content(Builder) - Method in class org.springdoc.core.fn.builders.requestbody.Builder

Content request body builder.

contentBuilder() - Static method in class org.springdoc.core.fn.builders.content.Builder

Builder content builder.

contentType(String) - Method in class org.springdoc.core.fn.builders.encoding.Builder

Content type encoding builder.

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

The Context path.

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.

convert(Object, TypeDescriptor) - Method in class org.springdoc.core.providers.WebConversionServiceProvider

Attempts to convert source into the target type as described by targetTypeDescriptor.

ConverterUtils - Class in org.springdoc.core.converters

The type Converter utils.

createJson(SpringDocConfigProperties) - Static method in class org.springdoc.core.providers.ObjectMapperProvider

Create json object mapper.

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.

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

The constant CSRF_DEFAULT_LOCAL_STORAGE_KEY

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

The Router function data.

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

customise(OpenAPIService) - Method in interface org.springdoc.core.customizers.OpenApiBuilderCustomizer

Customise.

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

Customise.

customise(OpenAPI, Locale) - Method in interface org.springdoc.core.customizers.OpenApiLocaleCustomizer

Customise.

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

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

customiseParameter(Parameter, ParameterInfo, List<Parameter>) - Method in class org.springdoc.core.AbstractRequestService

Customise parameter parameter.

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

customize(MethodParameter, MethodParameter) - Method in class org.springdoc.core.customizers.DataRestDelegatingMethodParameterCustomizer

customize(RouterOperation) - Method in interface org.springdoc.core.customizers.DataRestRouterOperationCustomizer

Customize router operation.

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(RouterOperation, HandlerMethod) - Method in interface org.springdoc.core.customizers.RouterOperationCustomizer

Customize router operation.

customize(String) - Method in interface org.springdoc.core.customizers.ServerBaseUrlCustomizer

Customise.

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

Customize method parameter [ ].

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

Customize.

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

Customise operation operation.

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

Customise router operation

D

DataRestDelegatingMethodParameterCustomizer - Class in org.springdoc.core.customizers

The type Data rest delegating method parameter customizer.

DataRestDelegatingMethodParameterCustomizer(Optional<SpringDataWebPropertiesProvider>, Optional<RepositoryRestConfigurationProvider>) - Constructor for class org.springdoc.core.customizers.DataRestDelegatingMethodParameterCustomizer

Instantiates a new Data rest delegating method parameter customizer.

DataRestRouterOperationCustomizer - Interface in org.springdoc.core.customizers

The interface Data rest router operation customizer.

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

Decode string.

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

The constant DEEP_LINKING.

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

Enables or disables deep linking for tags and operations.

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

The constant DEFAULT_API_DOCS_ACTUATOR_URL.

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_ACTUATOR_PATH - Static variable in class org.springdoc.core.Constants

The constant DEFAULT_SWAGGER_UI_ACTUATOR_PATH.

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.

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

The constant DEFAULT_YAML_API_DOCS_ACTUATOR_PATH.

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(String) - Method in class org.springdoc.core.fn.builders.schema.Builder

Default value schema builder.

defaultValue(String) - Method in class org.springdoc.core.fn.builders.servervariable.Builder

Default value server variable builder.

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.

deprecated(boolean) - Method in class org.springdoc.core.fn.builders.header.Builder

Deprecated header builder.

deprecated(boolean) - Method in class org.springdoc.core.fn.builders.operation.Builder

Deprecated operation builder.

deprecated(boolean) - Method in class org.springdoc.core.fn.builders.parameter.Builder

Deprecated parameter builder.

deprecated(boolean) - Method in class org.springdoc.core.fn.builders.schema.Builder

Deprecated schema builder.

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

description(String) - Method in class org.springdoc.core.fn.builders.apiresponse.Builder

Description api response builder.

description(String) - Method in class org.springdoc.core.fn.builders.exampleobject.Builder

Description example object builder.

description(String) - Method in class org.springdoc.core.fn.builders.externaldocumentation.Builder

Description external documentation builder.

description(String) - Method in class org.springdoc.core.fn.builders.header.Builder

Description header builder.

description(String) - Method in class org.springdoc.core.fn.builders.link.Builder

Description link builder.

description(String) - Method in class org.springdoc.core.fn.builders.operation.Builder

Description operation builder.

description(String) - Method in class org.springdoc.core.fn.builders.parameter.Builder

Description parameter builder.

description(String) - Method in class org.springdoc.core.fn.builders.requestbody.Builder

Description request body builder.

description(String) - Method in class org.springdoc.core.fn.builders.schema.Builder

Description schema builder.

description(String) - Method in class org.springdoc.core.fn.builders.server.Builder

Description server builder.

description(String) - Method in class org.springdoc.core.fn.builders.servervariable.Builder

Description server variable builder.

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.

discriminatorMapping(Builder) - Method in class org.springdoc.core.fn.builders.schema.Builder

Discriminator mapping schema builder.

discriminatorMappingBuilder() - Static method in class org.springdoc.core.fn.builders.discriminatormapping.Builder

A discriminator mapping builde discriminator mapping builder.

discriminatorProperty(String) - Method in class org.springdoc.core.fn.builders.schema.Builder

Discriminator property schema builder.

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

The constant DISPLAY_OPERATION_ID.

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

The constant DISPLAY_REQUEST_DURATION.

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

Display name builder.

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.

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

The constant DOT.

E

encoding(Builder) - Method in class org.springdoc.core.fn.builders.content.Builder

Encoding content builder.

encodingBuilder() - Static method in class org.springdoc.core.fn.builders.encoding.Builder

Builder encoding builder.

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.

enumAsRef(boolean) - Method in class org.springdoc.core.fn.builders.schema.Builder

Enum as ref schema builder.

environment - Variable in class org.springdoc.core.SpringdocBeanFactoryConfigurer

The Environment.

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.converters.models.Sort

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

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

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

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

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

Evaluate response status string.

example(Builder) - Method in class org.springdoc.core.fn.builders.content.Builder

Example content builder.

example(String) - Method in class org.springdoc.core.fn.builders.parameter.Builder

Example parameter builder.

example(String) - Method in class org.springdoc.core.fn.builders.schema.Builder

Example schema builder.

exampleOjectBuilder() - Static method in class org.springdoc.core.fn.builders.exampleobject.Builder

An example object example object builder.

examples(Builder) - Method in class org.springdoc.core.fn.builders.parameter.Builder

Examples parameter builder.

exclusiveMaximum(boolean) - Method in class org.springdoc.core.fn.builders.schema.Builder

Exclusive maximum schema builder.

exclusiveMinimum(boolean) - Method in class org.springdoc.core.fn.builders.schema.Builder

Exclusive minimum schema builder.

explode(boolean) - Method in class org.springdoc.core.fn.builders.encoding.Builder

Explode encoding builder.

explode(Explode) - Method in class org.springdoc.core.fn.builders.parameter.Builder

Explode parameter builder.

expression(String) - Method in class org.springdoc.core.fn.builders.linkparameter.Builder

Expression link parameter builder.

extension(Builder) - Method in class org.springdoc.core.fn.builders.apiresponse.Builder

Extension api response builder.

extension(Builder) - Method in class org.springdoc.core.fn.builders.arrayschema.Builder

Extension array schema builder.

extension(Builder) - Method in class org.springdoc.core.fn.builders.content.Builder

Extension content builder.

extension(Builder) - Method in class org.springdoc.core.fn.builders.encoding.Builder

Extension encoding builder.

extension(Builder) - Method in class org.springdoc.core.fn.builders.exampleobject.Builder

Extensions example object builder.

extension(Builder) - Method in class org.springdoc.core.fn.builders.externaldocumentation.Builder

Extensions external documentation builder.

extension(Builder) - Method in class org.springdoc.core.fn.builders.link.Builder

Extension link builder.

extension(Builder) - Method in class org.springdoc.core.fn.builders.requestbody.Builder

Extension request body builder.

extension(Builder) - Method in class org.springdoc.core.fn.builders.server.Builder

Extension server builder.

extension(Builder) - Method in class org.springdoc.core.fn.builders.servervariable.Builder

Extension server variable builder.

extensionBuilder() - Static method in class org.springdoc.core.fn.builders.extension.Builder

Builder extension builder.

extensionPropertyBuilder() - Static method in class org.springdoc.core.fn.builders.extensionproperty.Builder

An extension property extension property builder.

extensions(Builder) - Method in class org.springdoc.core.fn.builders.operation.Builder

Extensions operation builder.

extensions(Builder) - Method in class org.springdoc.core.fn.builders.parameter.Builder

Extensions parameter builder.

extensions(Builder) - Method in class org.springdoc.core.fn.builders.schema.Builder

Extensions schema builder.

externalDocs(Builder) - Method in class org.springdoc.core.fn.builders.operation.Builder

External docs operation builder.

externalDocs(Builder) - Method in class org.springdoc.core.fn.builders.schema.Builder

External docs schema builder.

externalDocumentationBuilder() - Static method in class org.springdoc.core.fn.builders.externaldocumentation.Builder

An external documentation external documentation builder.

externalValue(String) - Method in class org.springdoc.core.fn.builders.exampleobject.Builder

External value example object builder.

extractSchema(Components, Type, JsonView, Annotation[], SpecVersion) - 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(ObjectMapperProvider) - Constructor for class org.springdoc.core.converters.FileSupportConverter

Instantiates a new File support converter.

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.

findPathPrefix(SpringDocConfigProperties) - Method in class org.springdoc.core.providers.SpringWebProvider

Find path prefix string.

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

Find type for generics.

findWebJarResourcePath(String) - Method in class org.springdoc.ui.AbstractSwaggerResourceResolver

Find web jar resource path string.

format(String) - Method in class org.springdoc.core.fn.builders.schema.Builder

Format schema builder.

G

generateParameterBySchema(Schema) - Method in class org.springdoc.core.GenericParameterService

Generate parameter by schema

GenericParameterService - Class in org.springdoc.core

The type Generic parameter builder.

GenericParameterService(PropertyResolverUtils, Optional<DelegatingMethodParameterCustomizer>, Optional<WebConversionServiceProvider>, ObjectMapperProvider, Optional<JavadocProvider>) - Constructor for class org.springdoc.core.GenericParameterService

Instantiates a new Generic parameter builder.

GenericResponseService - Class in org.springdoc.core

The type Generic response builder.

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

Instantiates a new Generic response builder.

get$anchor() - Method in interface org.springdoc.api.mixins.SortedSchemaMixin

Get anchor string.

get$id() - Method in interface org.springdoc.api.mixins.SortedSchemaMixin

Get id string.

get$ref() - Method in class org.springdoc.core.ParameterId

Get ref string.

get$schema() - Method in interface org.springdoc.api.mixins.SortedSchemaMixin

Get schema string.

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

The constant GET_METHOD.

getActivated() - Method in class org.springdoc.core.SwaggerUiConfigProperties.SyntaxHighlight

Gets activated.

getActivePatterns(Object) - Method in class org.springdoc.core.providers.SpringWebProvider

Gets active patterns.

getActuatorPath() - Method in class org.springdoc.core.providers.ActuatorProvider

Gets actuator path.

getActuatorPort() - Method in class org.springdoc.core.providers.ActuatorProvider

Gets actuator port.

getActuatorProvider() - Method in class org.springdoc.core.SpringDocProviders

Gets actuator provider.

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

Gets actuator uri.

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.

getApiResponses(Method) - Method in class org.springdoc.core.GenericResponseService

Gets api responses.

getApiResponses() - Method in class org.springdoc.core.MethodAdviceInfo

Gets api responses.

getApplicationPort() - Method in class org.springdoc.core.providers.ActuatorProvider

Gets application port.

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

Gets app name.

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

Gets attributes.

getBasePath() - Method in class org.springdoc.core.providers.ActuatorProvider

Gets base path.

getBasePathAwareControllerEndpoints() - Method in interface org.springdoc.core.providers.RepositoryRestResourceProvider

Gets Base PathAwar eController endpoints.

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(Locale) - Method in class org.springdoc.core.OpenAPIService

Gets cached open api.

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

Get class consumes string [ ].

getClassJavadoc(Class<?>) - Method in interface org.springdoc.core.providers.JavadocProvider

Gets class description.

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 [ ].

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

Gets consumes to match.

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

Gets consumes to match.

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

Gets consumes to match.

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

getContains() - Method in interface org.springdoc.api.mixins.SortedSchemaMixin

Gets contains.

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

Gets content.

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

Gets context.

getContextPath() - Method in class org.springdoc.core.providers.ActuatorProvider

Gets context path.

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

Gets controller advice.

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

Gets controller advice map.

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

Gets cookie name.

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

Gets csrf.

getDataRestRouterOperationCustomizers() - Method in class org.springdoc.core.customizers.SpringDocCustomizers

Gets data rest router operation customizers.

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.

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

Gets default value.

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

Gets delegating method parameter customizer.

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

Gets deprecating converter.

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

Gets display name.

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

Gets display name.

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

Gets display name.

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.

getExample() - Method in interface org.springdoc.api.mixins.SortedSchemaMixin

Gets example.

getExample() - Method in interface org.springdoc.api.mixins.SortedSchemaMixin31

Gets example.

getExampleSetFlag() - Method in interface org.springdoc.api.mixins.SortedSchemaMixin

Gets example set flag.

getExampleSetFlag() - Method in interface org.springdoc.api.mixins.SortedSchemaMixin31

Gets example set flag.

getExceptions() - Method in class org.springdoc.core.MethodAdviceInfo

Gets exceptions.

getExclusiveMaximum() - Method in interface org.springdoc.api.mixins.SortedSchemaMixin31

Gets exclusive maximum.

getExclusiveMaximumValue() - Method in interface org.springdoc.api.mixins.SortedSchemaMixin

Gets exclusive maximum value.

getExclusiveMaximumValue() - Method in interface org.springdoc.api.mixins.SortedSchemaMixin31

Gets exclusive maximum value.

getExclusiveMinimum() - Method in interface org.springdoc.api.mixins.SortedSchemaMixin31

Gets exclusive minimum.

getExclusiveMinimumValue() - Method in interface org.springdoc.api.mixins.SortedSchemaMixin

Gets exclusive minimum value.

getExclusiveMinimumValue() - Method in interface org.springdoc.api.mixins.SortedSchemaMixin31

Gets exclusive minimum value.

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

getExtensions() - Method in interface org.springdoc.api.mixins.SortedOpenAPIMixin

Gets extensions.

getExtensions() - Method in interface org.springdoc.api.mixins.SortedOpenAPIMixin31

Gets extensions.

getExtensions() - Method in interface org.springdoc.api.mixins.SortedSchemaMixin

Gets extensions.

getExtensions() - Method in interface org.springdoc.api.mixins.SortedSchemaMixin31

Gets extensions.

getFactory() - Method in class org.springdoc.core.PropertyResolverUtils

Gets factory.

getFieldJavadoc(Field) - Method in interface org.springdoc.core.providers.JavadocProvider

Gets field javadoc.

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

Gets filter.

getFirstSentence(String) - Method in interface org.springdoc.core.providers.JavadocProvider

Returns the first sentence of a javadoc comment.

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

Gets framework endpoints.

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

Gets generic map response.

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

getGlobalOpenApiCustomizers() - Method in class org.springdoc.core.customizers.SpringDocCustomizers

Gets global open api customizers.

getGlobalOpenApiMethodFilters() - Method in class org.springdoc.core.customizers.SpringDocCustomizers

Gets global open api method filters.

getGlobalOperationCustomizers() - Method in class org.springdoc.core.customizers.SpringDocCustomizers

Gets global operation customizers.

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.providers.RepositoryRestResourceProvider

Gets handler methods.

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

Gets handler methods.

getHandlerMethods() - Method in class org.springdoc.core.providers.SpringWebProvider

Gets handler methods.

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

Gets header name.

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

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.

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

Gets headers to match.

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

Gets headers to match.

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

Gets headers to match.

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

Gets id.

getJavadocProvider() - Method in class org.springdoc.core.GenericParameterService

Gets javadoc provider.

getJavadocProvider() - Method in class org.springdoc.core.OperationService

Gets javadoc provider.

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

Gets javadoc return value

getJsonSchema() - Method in interface org.springdoc.api.mixins.SortedSchemaMixin

Gets json schema.

getJsonSchema() - Method in interface org.springdoc.api.mixins.SortedSchemaMixin31

Gets json schema.

getJsonSchemaImpl() - Method in interface org.springdoc.api.mixins.SortedSchemaMixin

Gets json schema.

getJsonSchemaImpl() - Method in interface org.springdoc.api.mixins.SortedSchemaMixin31

Gets json schema.

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.

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

Gets locale.

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

Gets local storage key.

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

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

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

Gets method.

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

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

Get method consumes string [ ].

getMethodFilters() - Method in class org.springdoc.core.customizers.SpringDocCustomizers

Gets method filters.

getMethodJavadocDescription(Method) - Method in interface org.springdoc.core.providers.JavadocProvider

Gets method description.

getMethodJavadocReturn(Method) - Method in interface org.springdoc.core.providers.JavadocProvider

Gets method javadoc return.

getMethodJavadocThrows(Method) - Method in interface org.springdoc.core.providers.JavadocProvider

Gets method throws declaration.

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 class org.springdoc.core.fn.RouterFunctionData

Get methods request method [ ].

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

Get methods request method [ ].

getMethods() - Method in class org.springdoc.core.providers.ActuatorProvider

Gets methods.

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

Gets model converters.

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

getNullable() - Method in interface org.springdoc.api.mixins.SortedSchemaMixin31

Gets nullable.

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

Gets oauth 2 redirect url.

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

Gets oauth2 redirect url.

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

Gets open api.

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

Gets open api customisers.

getOpenApiCustomizers() - Method in class org.springdoc.core.customizers.SpringDocCustomizers

Gets open api customizers.

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

Gets open api method filters.

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

Gets operation.

getOperationBuilder(Consumer<Builder>) - Method in class org.springdoc.core.fn.AbstractSpringdocRouteBuilder

Gets operation builder.

getOperationCustomizers() - Method in class org.springdoc.core.customizers.SpringDocCustomizers

Gets operation customizers.

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

Gets operation customizers.

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

Gets operation id.

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

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.

getOptionalWebConversionServiceProvider() - Method in class org.springdoc.core.GenericParameterService

Gets optional web conversion service provider.

getOptionalWebConversionServiceProvider() - Method in class org.springdoc.core.SpringDocProviders

Gets optional web conversion service provider.

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

Gets override with generic response.

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.

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

Gets pageable converter.

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

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

Gets parameter id.

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

Gets parameter model.

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

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

Gets replacement.

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

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

Get parameter types class [ ].

getParamJavadoc(Method, String) - Method in interface org.springdoc.core.providers.JavadocProvider

Gets param javadoc.

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

Get params string [ ].

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

Gets params.

getParamType() - Method in class org.springdoc.core.ParameterId

Gets param type.

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

Gets param type.

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>, Locale, OpenAPI) - Method in class org.springdoc.api.AbstractOpenApiResource

Gets paths.

getPaths() - Method in interface org.springdoc.api.mixins.SortedOpenAPIMixin

Gets paths.

getPaths() - Method in interface org.springdoc.api.mixins.SortedOpenAPIMixin31

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.

getPatternProperties() - Method in interface org.springdoc.api.mixins.SortedSchemaMixin

Gets pattern properties.

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

Gets persist authorization.

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

Gets name.

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

Gets name.

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

Gets polymorphic model converter.

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

Gets prefix.

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

locale list to pre-loading.

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

Get produces string [ ].

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

Get produces string [ ].

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

Gets produces to match.

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

Gets produces to match.

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

Gets produces to match.

getPropertyResolverUtils() - Method in class org.springdoc.core.GenericParameterService

Gets property resolver utils.

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

Gets query config enabled.

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.

getRecordClassParamJavadoc(Class<?>) - Method in interface org.springdoc.core.providers.JavadocProvider

Gets param descripton of record class.

getRepositoryRestConfiguration() - Method in class org.springdoc.core.providers.RepositoryRestConfigurationProvider

Gets repository rest configuration.

getRepositoryRestResourceProvider() - Method in class org.springdoc.core.SpringDocProviders

Gets repository rest resource provider.

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

Gets request body.

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

Gets request body builder.

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, Locale, OpenAPI) - Method in class org.springdoc.api.AbstractOpenApiResource

Gets router function paths.

getRouterFunctionPaths() - Method in interface org.springdoc.core.providers.RouterFunctionProvider

Gets router function paths.

getRouterFunctionPaths(String, RequestMethod) - Method in class org.springdoc.core.providers.SpringCloudFunctionProvider

Gets router function paths.

getRouterFunctionProvider() - Method in class org.springdoc.core.SpringDocProviders

Gets router function provider.

getRouterOperationCustomizers() - Method in class org.springdoc.core.customizers.SpringDocCustomizers

Gets router operation customizers.

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

Gets router operation customizers.

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

Gets router operations.

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

Gets router operations.

getRouterOperations(OpenAPI) - Method in class org.springdoc.core.providers.SpringCloudFunctionProvider

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

Gets security parser.

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

Get security requirements io .

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

Gets security requirements.

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

Gets security requirements for class.

getSecurityRequirementsForMethod(Method, Set<SecurityRequirement>) - Method in class org.springdoc.core.SecurityService

Gets security requirements for method.

getServerBaseUrl() - Method in class org.springdoc.core.OpenAPIService

Gets server base URL

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

Gets session storage key.

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.

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

Gets sort.

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

Gets sort converter.

getSpecVersion() - Method in class org.springdoc.core.PropertyResolverUtils

Gets spec version.

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

Gets spec version.

getSpringCloudFunctionProvider() - Method in class org.springdoc.core.SpringDocProviders

Gets spring cloud function provider.

getSpringConvertedType(Class<?>) - Method in class org.springdoc.core.providers.WebConversionServiceProvider

Gets spring converted type.

getSpringDataWebProperties() - Method in class org.springdoc.core.providers.SpringDataWebPropertiesProvider

Gets spring data web properties.

getSpringDocConfigProperties() - Method in class org.springdoc.core.PropertyResolverUtils

Gets spring doc config properties.

getSpringSecurityOAuth2Provider() - Method in class org.springdoc.core.SpringDocProviders

Gets spring security o auth 2 provider.

getSpringWebProvider() - Method in class org.springdoc.core.SpringDocProviders

Gets spring web provider.

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

Gets supported submit methods.

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

Gets swagger ui url.

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

Gets syntaxHighlight.

getTag() - Static method in class org.springdoc.core.providers.ActuatorProvider

Gets tag.

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

Gets tags sorter.

getTheme() - Method in class org.springdoc.core.SwaggerUiConfigProperties.SyntaxHighlight

Gets theme.

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

Gets try it out enabled

getType() - Method in interface org.springdoc.api.mixins.SortedSchemaMixin31

Gets type.

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

Gets type.

getTypes() - Method in interface org.springdoc.api.mixins.SortedSchemaMixin

Gets types.

getTypes() - Method in interface org.springdoc.api.mixins.SortedSchemaMixin31

Gets types.

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.

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

Gets version.

getVersion() - Method in enum org.springdoc.core.SpringDocConfigProperties.ApiDocs.OpenApiVersion

Gets open api version.

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

Gets swagger ui version.

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

Gets webjars.

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

Gets with credentials.

GlobalOpenApiCustomizer - Interface in org.springdoc.core.customizers

Implement and register a bean of type GlobalOpenApiCustomizer to customize Open api on default OpenAPI description and groups.

GlobalOpenApiMethodFilter - Interface in org.springdoc.core.filters

Implement and register a bean of type GlobalOpenApiMethodFilter to conditionally including any detected methods in default OpenAPI description and groups.

GlobalOperationCustomizer - Interface in org.springdoc.core.customizers

Implement and register a bean of type GlobalOperationCustomizer to customize an operation based on the handler method input on default OpenAPI description and groups

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_OR_EMPTY - 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>, List<String>, List<String>, List<String>, 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.

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

The Group name.

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

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

The Groups order.

H

handlerMethods - Variable in class org.springdoc.core.providers.SpringWebProvider

The Handler methods.

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.converters.models.Sort

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

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

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

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

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.

header(Builder) - Method in class org.springdoc.core.fn.builders.apiresponse.Builder

Header api response builder.

headerBuilder() - Static method in class org.springdoc.core.fn.builders.header.Builder

Builder header builder.

headers(Builder) - Method in class org.springdoc.core.fn.builders.encoding.Builder

Headers encoding builder.

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

Headers to match builder.

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

The constant HEALTH_PATTERN.

hidden(boolean) - Method in class org.springdoc.core.fn.builders.operation.Builder

Hidden operation builder.

hidden(boolean) - Method in class org.springdoc.core.fn.builders.parameter.Builder

Hidden parameter builder.

hidden(boolean) - Method in class org.springdoc.core.fn.builders.schema.Builder

Hidden schema builder.

I

ignoreJsonView(boolean) - Method in class org.springdoc.core.fn.builders.operation.Builder

Ignore json view operation builder.

implementation(Class) - Method in class org.springdoc.core.fn.builders.apiresponse.Builder

Implementation api response builder.

implementation(Class) - Method in class org.springdoc.core.fn.builders.parameter.Builder

Implementation parameter builder.

implementation(Class) - Method in class org.springdoc.core.fn.builders.requestbody.Builder

Implementation request body builder.

implementation(Class<?>) - Method in class org.springdoc.core.fn.builders.schema.Builder

Implementation schema builder.

implementationArray(Class) - Method in class org.springdoc.core.fn.builders.apiresponse.Builder

Implementation array api response builder.

implementationArray(Class) - Method in class org.springdoc.core.fn.builders.parameter.Builder

Implementation array parameter builder.

in(ParameterIn) - Method in class org.springdoc.core.fn.builders.parameter.Builder

In parameter builder.

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

The constant INDEX_PAGE.

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

Init.

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

Init bean factory post processor.

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

Init open api builder.

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

isActuatorRestController(String, HandlerMethod) - Method in class org.springdoc.api.AbstractOpenApiResource

Is actuator rest controller boolean.

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

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.

isConditionToMatch(String[], AbstractOpenApiResource.ConditionType) - Method in class org.springdoc.api.AbstractOpenApiResource

Is condition to match boolean.

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

Is csrf enabled boolean.

isDefaultFlatParamObject() - Method in class org.springdoc.core.AbstractRequestService

Is default flat param object boolean.

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

Is default flat param object boolean.

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

Gets default override with generic response.

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

Is default support form data boolean.

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

Is deprecated boolean.

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

Is disabled boolean.

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

Is disable i 18 n boolean.

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

Is disable swagger default url 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.SpringDocConfigProperties.ModelConverters.PageableConverter

Is enabled boolean.

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

Is enabled boolean.

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

Is enabled boolean.

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

Is enabled boolean.

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

Is enabled boolean.

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

Is enable data rest boolean.

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

Is enable groovy boolean.

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

Is enable hateoas boolean.

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

Is enable javadoc boolean.

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

Is enable kotlin boolean.

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

Is enable spring security boolean.

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

Is file boolean.

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

Is file boolean.

isFilterCondition(HandlerMethod, String, String[], String[], String[]) - Method in class org.springdoc.api.AbstractOpenApiResource

Is filter condition 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.OperationService

Is hidden boolean.

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

Is hidden rest controllers boolean.

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

Is java type to ignore boolean.

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

Is method overloaded boolean.

isMethodToFilter(HandlerMethod) - Method in class org.springdoc.api.AbstractOpenApiResource

Is target method suitable for inclusion in current documentation/

isMethodToInclude(Method) - Method in interface org.springdoc.core.filters.OpenApiMethodFilter

Whether the given method should be included in the generated OpenApi definitions.

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.

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

Is not required boolean.

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

Is nullable request parameter enabled boolean.

isOpenapi31() - Method in class org.springdoc.core.GenericParameterService

Is openapi 31 boolean.

isOpenapi31() - Method in class org.springdoc.core.PropertyResolverUtils

Is openapi 31 boolean.

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

Is openapi 31 boolean.

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

The Is or.

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

Is param to ignore boolean.

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

Is path to match boolean.

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

Is pre loading enabled boolean.

isPresent() - Method in class org.springdoc.core.SwaggerUiConfigProperties.SyntaxHighlight

Is present boolean.

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

Is remove broken reference definitions boolean.

isRepositoryRestConfigurationPresent() - Method in class org.springdoc.core.providers.RepositoryRestConfigurationProvider

Is repository rest configuration present boolean.

isRequestBodyPresent(ParameterInfo) - Method in class org.springdoc.core.GenericParameterService

Is request body present boolean.

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

Is request part boolean.

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

Is request type to ignore boolean.

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

Is required boolean.

isResolveExtensionsProperties() - Method in class org.springdoc.core.PropertyResolverUtils

Is resolve extensions properties boolean.

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

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(Map<String, Object>, HandlerMethod, String) - Method in class org.springdoc.api.AbstractOpenApiResource

Is rest controller boolean.

isRestController(String, HandlerMethod) - Method in class org.springdoc.core.providers.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.

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

Is show oauth 2 endpoints boolean.

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

Is show spring cloud functions boolean.

isSpringDataWebPropertiesPresent() - Method in class org.springdoc.core.providers.SpringDataWebPropertiesProvider

Is spring data web properties present boolean.

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

Is use fqn boolean.

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

Use Local storage boolean.

isUseManagementPort() - Method in class org.springdoc.core.providers.ActuatorProvider

Is use management port boolean.

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

Is use management port boolean.

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

Is use root path boolean.

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

Use Session storage boolean.

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

Is valid parameter boolean.

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

Is valid path 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.

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

Is writer wither order by keys boolean.

J

JavadocProvider - Interface in org.springdoc.core.providers

The interface Javadoc provider.

JavaTypeToIgnoreConverter - Class in org.springdoc.core.converters

The type Request type to ignore converter.

JavaTypeToIgnoreConverter(ObjectMapperProvider) - Constructor for class org.springdoc.core.converters.JavaTypeToIgnoreConverter

Instantiates a new Request type to ignore converter.

jsonMapper() - Method in class org.springdoc.core.providers.ObjectMapperProvider

Mapper object mapper.

jsonMapper() - Method in class org.springdoc.core.SpringDocProviders

Json mapper object mapper.

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.

link(Builder) - Method in class org.springdoc.core.fn.builders.apiresponse.Builder

Link api response builder.

linkBuilder() - Static method in class org.springdoc.core.fn.builders.link.Builder

Builder link builder.

linkParameterBuilder() - Static method in class org.springdoc.core.fn.builders.linkparameter.Builder

Builder link parameter builder.

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

The constant LINKS_SCHEMA_CUSTOMISER.

M

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

The constant MANAGEMENT_ENDPOINTS_WEB.

managementApplicationContext - Variable in class org.springdoc.core.providers.ActuatorProvider

The Management application context.

managementServerProperties - Variable in class org.springdoc.core.providers.ActuatorProvider

The Management server properties.

matches(ConditionContext, AnnotatedTypeMetadata) - Method in class org.springdoc.core.SpecPropertiesCondition

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

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

maximum(String) - Method in class org.springdoc.core.fn.builders.schema.Builder

Maximum schema builder.

maxItems(int) - Method in class org.springdoc.core.fn.builders.arrayschema.Builder

Max items array schema builder.

maxLength(int) - Method in class org.springdoc.core.fn.builders.schema.Builder

Max length schema builder.

maxProperties(int) - Method in class org.springdoc.core.fn.builders.schema.Builder

Max properties schema builder.

mediaType(String) - Method in class org.springdoc.core.fn.builders.content.Builder

Media type content builder.

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

Merge operation operation.

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

Merge parameter parameter.

mergeParameter(Parameter, Parameter) - Static method in class org.springdoc.core.GenericParameterService

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

method(String) - Method in class org.springdoc.core.fn.builders.operation.Builder

Method operation builder.

MethodAdviceInfo - Class in org.springdoc.core

The type Method advice info.

MethodAdviceInfo(Method) - Constructor for class org.springdoc.core.MethodAdviceInfo

Instantiates a new Method advice info.

MethodAttributes - Class in org.springdoc.core

The type Method attributes.

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

Instantiates a new Method attributes.

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

Instantiates a new Method attributes.

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

Instantiates a new Method attributes.

minimum(String) - Method in class org.springdoc.core.fn.builders.schema.Builder

Minimum schema builder.

minItems(int) - Method in class org.springdoc.core.fn.builders.arrayschema.Builder

Min items array schema builder.

minLength(int) - Method in class org.springdoc.core.fn.builders.schema.Builder

Min length schema builder.

minProperties(int) - Method in class org.springdoc.core.fn.builders.schema.Builder

Min properties schema builder.

ModelConverterRegistrar - Class in org.springdoc.core.converters

Wrapper for model converters to only register converters once

ModelConverterRegistrar(List<ModelConverter>, SpringDocConfigProperties) - 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

multipleOf(double) - Method in class org.springdoc.core.fn.builders.schema.Builder

Multiple of schema builder.

MultipleOpenApiGroupsCondition - Class in org.springdoc.core

The type Multiple open api support condition.

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

name(String) - Method in class org.springdoc.core.fn.builders.encoding.Builder

Name encoding builder.

name(String) - Method in class org.springdoc.core.fn.builders.exampleobject.Builder

Name example object builder.

name(String) - Method in class org.springdoc.core.fn.builders.extension.Builder

Name extension builder.

name(String) - Method in class org.springdoc.core.fn.builders.extensionproperty.Builder

Name extension property builder.

name(String) - Method in class org.springdoc.core.fn.builders.header.Builder

Name header builder.

name(String) - Method in class org.springdoc.core.fn.builders.link.Builder

Name link builder.

name(String) - Method in class org.springdoc.core.fn.builders.linkparameter.Builder

Name link parameter builder.

name(String) - Method in class org.springdoc.core.fn.builders.parameter.Builder

Name parameter builder.

name(String) - Method in class org.springdoc.core.fn.builders.schema.Builder

Name schema builder.

name(String) - Method in class org.springdoc.core.fn.builders.securityrequirement.Builder

Name security requirement builder.

name(String) - Method in class org.springdoc.core.fn.builders.servervariable.Builder

Name server variable builder.

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

The Nested and paths.

not(Class<?>) - Method in class org.springdoc.core.fn.builders.schema.Builder

Not schema builder.

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

The constant NULL.

nullable(boolean) - Method in class org.springdoc.core.fn.builders.schema.Builder

Nullable schema builder.

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.

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

the constant OAUTH_REDIRECT_PAGE.

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

The Object mapper.

ObjectMapperProvider - Class in org.springdoc.core.providers

The type Spring doc object mapper provider.

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

Instantiates a new Spring doc object mapper.

onApplicationEvent(WebServerInitializedEvent) - Method in class org.springdoc.core.providers.ActuatorProvider

oneOf(Class<?>[]) - Method in class org.springdoc.core.fn.builders.schema.Builder

One of schema builder.

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.

OpenApiBuilderCustomizer - Interface in org.springdoc.core.customizers

The interface Open api builder customiser.

OpenApiCustomiser - Interface in org.springdoc.core.customizers

Implement and register a bean of type OpenApiCustomiser to customize Open api on default OpenAPI description but not on groups

OpenApiLocaleCustomizer - Interface in org.springdoc.core.customizers

The interface Open api locale customizer.

OpenApiMethodFilter - Interface in org.springdoc.core.filters

Implement and register a bean of type OpenApiMethodFilter to conditionally include any detected methods in default OpenAPI descriptions but not groups

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.

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

The Open api builder.

OpenAPIService - Class in org.springdoc.core

The type Open api builder.

OpenAPIService(Optional<OpenAPI>, SecurityService, SpringDocConfigProperties, PropertyResolverUtils, Optional<List<OpenApiBuilderCustomizer>>, Optional<List<ServerBaseUrlCustomizer>>, Optional<JavadocProvider>) - Constructor for class org.springdoc.core.OpenAPIService

Instantiates a new Open api builder.

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

The constant OPERATION_ATTRIBUTE.

operationBuilder() - Static method in class org.springdoc.core.fn.builders.operation.Builder

Builder 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 on default OpenAPI descriptions but not groups

operationId(String) - Method in class org.springdoc.core.fn.builders.link.Builder

Operation id link builder.

operationId(String) - Method in class org.springdoc.core.fn.builders.operation.Builder

Operation id operation builder.

operationRef(String) - Method in class org.springdoc.core.fn.builders.link.Builder

Operation ref link builder.

OperationService - Class in org.springdoc.core

The type Operation builder.

OperationService(GenericParameterService, RequestBodyService, SecurityService, PropertyResolverUtils) - Constructor for class org.springdoc.core.OperationService

Instantiates a new Operation builder.

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

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

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

org.springdoc.core.fn.builders.apiresponse - package org.springdoc.core.fn.builders.apiresponse

org.springdoc.core.fn.builders.arrayschema - package org.springdoc.core.fn.builders.arrayschema

org.springdoc.core.fn.builders.content - package org.springdoc.core.fn.builders.content

org.springdoc.core.fn.builders.discriminatormapping - package org.springdoc.core.fn.builders.discriminatormapping

org.springdoc.core.fn.builders.encoding - package org.springdoc.core.fn.builders.encoding

org.springdoc.core.fn.builders.exampleobject - package org.springdoc.core.fn.builders.exampleobject

org.springdoc.core.fn.builders.extension - package org.springdoc.core.fn.builders.extension

org.springdoc.core.fn.builders.extensionproperty - package org.springdoc.core.fn.builders.extensionproperty

org.springdoc.core.fn.builders.externaldocumentation - package org.springdoc.core.fn.builders.externaldocumentation

org.springdoc.core.fn.builders.header - package org.springdoc.core.fn.builders.header

org.springdoc.core.fn.builders.link - package org.springdoc.core.fn.builders.link

org.springdoc.core.fn.builders.linkparameter - package org.springdoc.core.fn.builders.linkparameter

org.springdoc.core.fn.builders.operation - package org.springdoc.core.fn.builders.operation

org.springdoc.core.fn.builders.parameter - package org.springdoc.core.fn.builders.parameter

org.springdoc.core.fn.builders.requestbody - package org.springdoc.core.fn.builders.requestbody

org.springdoc.core.fn.builders.schema - package org.springdoc.core.fn.builders.schema

org.springdoc.core.fn.builders.securityrequirement - package org.springdoc.core.fn.builders.securityrequirement

org.springdoc.core.fn.builders.server - package org.springdoc.core.fn.builders.server

org.springdoc.core.fn.builders.servervariable - package org.springdoc.core.fn.builders.servervariable

org.springdoc.core.providers - package org.springdoc.core.providers

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

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

The Nested or paths.

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.

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

PageableOpenAPIConverter - Class in org.springdoc.core.converters

The Pageable Type models converter.

PageableOpenAPIConverter(ObjectMapperProvider) - Constructor for class org.springdoc.core.converters.PageableOpenAPIConverter

Instantiates a new Pageable open api converter.

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

Param.

parameter(Builder) - Method in class org.springdoc.core.fn.builders.link.Builder

Parameter link builder.

parameter(Builder) - Method in class org.springdoc.core.fn.builders.operation.Builder

Parameter operation builder.

parameterBuilder() - Static method in class org.springdoc.core.fn.builders.parameter.Builder

Builder parameter builder.

ParameterCustomizer - Interface in org.springdoc.core.customizers

Implement and register a bean of type ParameterCustomizer to customize a parameter based on the parameter and handler method input

ParameterId - Class in org.springdoc.core

The type Parameter Id.

ParameterId(Parameter) - Constructor for class org.springdoc.core.ParameterId

Instantiates a new Parameter id.

ParameterId(Parameter) - Constructor for class org.springdoc.core.ParameterId

Instantiates a new Parameter id.

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

Instantiates a new Parameter id.

ParameterInfo - Class in org.springdoc.core

The type Parameter info.

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

Instantiates a new Parameter info.

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

The interface Parameter object.

parameterTypes(Class<?>[]) - Method in class org.springdoc.core.fn.builders.operation.Builder

Parameter types operation builder.

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

Parse open api.

parseValue(boolean) - Method in class org.springdoc.core.fn.builders.extensionproperty.Builder

Parse value extension property builder.

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.

pattern(String) - Method in class org.springdoc.core.fn.builders.schema.Builder

Pattern schema builder.

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

The constant PERSIST_AUTHORIZATION_PROPERTY.

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

The Persist authorization.

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

PolymorphicModelConverter - Class in org.springdoc.core.converters

The type Polymorphic model converter.

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

Instantiates a new Polymorphic model converter.

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

The constant POST_METHOD.

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

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

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

Produces to match builder.

propertie(Builder) - Method in class org.springdoc.core.fn.builders.extension.Builder

Properties extension builder.

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, MessageSource, SpringDocConfigProperties) - 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_CONFIG_ENABLED_PROPERTY - Static variable in class org.springdoc.core.SwaggerUiConfigParameters

The constant QUERY_CONFIG_ENABLED_PROPERTY.

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

The constant QUERY_PARAM.

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

The Query config enabled.

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.

ref(String) - Method in class org.springdoc.core.fn.builders.apiresponse.Builder

Ref api response builder.

ref(String) - Method in class org.springdoc.core.fn.builders.exampleobject.Builder

Ref example object builder.

ref(String) - Method in class org.springdoc.core.fn.builders.header.Builder

Ref header builder.

ref(String) - Method in class org.springdoc.core.fn.builders.link.Builder

Ref link builder.

ref(String) - Method in class org.springdoc.core.fn.builders.parameter.Builder

Ref parameter builder.

ref(String) - Method in class org.springdoc.core.fn.builders.requestbody.Builder

Ref request body builder.

ref(String) - Method in class org.springdoc.core.fn.builders.schema.Builder

Ref schema builder.

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.

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

Remove from class map.

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

Remove from schema class spring doc utils.

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

Remove from schema map.

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

Remove from schema map spring doc utils.

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

Remove java type to ignore.

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

Remove java type to ignore spring doc utils.

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

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.

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

Replace ParameterObject with class.

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

Replace the ParameterObject with the target class.

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.

RepositoryRestConfigurationProvider - Class in org.springdoc.core.providers

The type Repository rest configuration provider.

RepositoryRestConfigurationProvider(Optional<RepositoryRestConfiguration>) - Constructor for class org.springdoc.core.providers.RepositoryRestConfigurationProvider

Instantiates a new Repository rest configuration provider.

RepositoryRestResourceProvider - Interface in org.springdoc.core.providers

The interface Repository rest resource provider.

requestBody(String) - Method in class org.springdoc.core.fn.builders.link.Builder

Request body link builder.

requestBody(Builder) - Method in class org.springdoc.core.fn.builders.operation.Builder

Request body operation builder.

requestBodyBuilder() - Static method in class org.springdoc.core.fn.builders.requestbody.Builder

Builder request body builder.

RequestBodyInfo - Class in org.springdoc.core

The type Request body info.

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

RequestBodyService - Class in org.springdoc.core

The type Request body builder.

RequestBodyService(GenericParameterService, PropertyResolverUtils) - Constructor for class org.springdoc.core.RequestBodyService

Instantiates a new Request body builder.

required(boolean) - Method in class org.springdoc.core.fn.builders.header.Builder

Required header builder.

required(boolean) - Method in class org.springdoc.core.fn.builders.parameter.Builder

Required parameter builder.

required(boolean) - Method in class org.springdoc.core.fn.builders.requestbody.Builder

Required request body builder.

required(boolean) - Method in class org.springdoc.core.fn.builders.schema.Builder

Required schema builder.

requiredMode(Schema.RequiredMode) - Method in class org.springdoc.core.fn.builders.schema.Builder

Required mode builder.

requiredProperties(String[]) - Method in class org.springdoc.core.fn.builders.schema.Builder

Required properties schema builder.

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

Resolve schema.

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

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

Resolve schema.

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

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

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

Resolve schema.

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

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

Resolve string.

resolveDefaultValue(String, ObjectMapper) - Static method in class org.springdoc.core.SpringDocAnnotationsUtils

Resolve default value object.

resolveEmbeddedValuesAndExpressions(String) - Method in class org.springdoc.core.GenericParameterService

Resolve the given annotation-specified value, potentially containing placeholders and expressions.

resolveExtensions(Locale, Map<String, Object>) - Method in class org.springdoc.core.PropertyResolverUtils

Resolve extensions map.

resolveProperties(List<Server>, Locale) - Method in class org.springdoc.core.PropertyResolverUtils

Resolve properties info.

resolveProperties(Info, Locale) - Method in class org.springdoc.core.PropertyResolverUtils

Resolve properties info.

resolveProperties(Schema<?>, Locale) - Method in class org.springdoc.core.PropertyResolverUtils

Resolve properties schema.

resolveSchemaFromType(Class<?>, Components, JsonView, Annotation[], SpecVersion) - 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.

response(Builder) - Method in class org.springdoc.core.fn.builders.operation.Builder

Response operation builder.

responseBuilder() - Static method in class org.springdoc.core.fn.builders.apiresponse.Builder

Builder api response builder.

responseCode(String) - Method in class org.springdoc.core.fn.builders.apiresponse.Builder

Response code api response builder.

ResponseSupportConverter - Class in org.springdoc.core.converters

The type Response support converter.

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

Instantiates a new Response support converter.

ReturnTypeParser - Interface in org.springdoc.core

The interface Return type parser.

RouterFunctionData - Class in org.springdoc.core.fn

The type Router function data.

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

Instantiates a new Router function data.

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

Instantiates a new Router function data.

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

The Router function datas.

RouterFunctionProvider - Interface in org.springdoc.core.providers

The interface Router function provider.

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() - Constructor for class org.springdoc.core.fn.RouterOperation

Instantiates a new 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[], String[], String[], String[], String[]) - Constructor for class org.springdoc.core.fn.RouterOperation

Instantiates a new Router operation.

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

Instantiates a new Router operation.

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

Instantiates a new Router operation.

RouterOperationCustomizer - Interface in org.springdoc.core.customizers

Implement and register a bean of type RouterOperationCustomizer to customize an router operation based on the handler method input on default OpenAPI descriptions but not groups

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

Container for repeatable RouterOperation annotation

S

schema(Builder) - Method in class org.springdoc.core.fn.builders.arrayschema.Builder

Schema array schema builder.

schema(Builder) - Method in class org.springdoc.core.fn.builders.content.Builder

Schema content builder.

schema(Class<?>) - Method in class org.springdoc.core.fn.builders.discriminatormapping.Builder

Schema discriminator mapping builder.

schema(Builder) - Method in class org.springdoc.core.fn.builders.header.Builder

Schema header builder.

schema(Builder) - Method in class org.springdoc.core.fn.builders.parameter.Builder

Schema parameter builder.

schemaBuilder() - Static method in class org.springdoc.core.fn.builders.schema.Builder

Builder schema builder.

SchemaPropertyDeprecatingConverter - Class in org.springdoc.core.converters

The type Schema property deprecating converter.

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

scopes(String[]) - Method in class org.springdoc.core.fn.builders.securityrequirement.Builder

Scopes security requirement builder.

security(Builder) - Method in class org.springdoc.core.fn.builders.operation.Builder

Security operation builder.

SecurityOAuth2Provider - Interface in org.springdoc.core.providers

The interface Security o auth 2 provider.

securityRequirementBuilder() - Static method in class org.springdoc.core.fn.builders.securityrequirement.Builder

Builder security requirement builder.

SecurityService - Class in org.springdoc.core

The type Security parser.

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

Instantiates a new Security parser.

server(Builder) - Method in class org.springdoc.core.fn.builders.link.Builder

Server link builder.

ServerBaseUrlCustomizer - Interface in org.springdoc.core.customizers

The interface Server Base URL customiser.

serverBuilder() - Static method in class org.springdoc.core.fn.builders.server.Builder

Builder server builder.

serverProperties - Variable in class org.springdoc.core.providers.ActuatorProvider

The Server properties.

servers(Builder) - Method in class org.springdoc.core.fn.builders.operation.Builder

Servers operation builder.

serverVariableBuilder() - Static method in class org.springdoc.core.fn.builders.servervariable.Builder

Builder server variable builder.

set$ref(String) - Method in class org.springdoc.core.ParameterId

Set ref.

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

Sets activated.

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.

setApiResponses(ApiResponses) - Method in class org.springdoc.core.MethodAdviceInfo

Sets api responses.

setApplicationContext(ApplicationContext) - Method in class org.springdoc.core.customizers.SpringDocCustomizers

setApplicationContext(ApplicationContext) - Method in class org.springdoc.core.OpenAPIService

setApplicationContext(ApplicationContext) - Method in class org.springdoc.core.providers.SpringCloudFunctionProvider

setApplicationContext(ApplicationContext) - Method in class org.springdoc.core.providers.SpringWebProvider

setApplicationContext(ApplicationContext) - Method in class org.springdoc.core.providers.WebConversionServiceProvider

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, Locale) - Method in class org.springdoc.core.OpenAPIService

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.

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

Setting the url configured with swagger ui properties

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

Sets config url.

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

Sets consumes.

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

Sets consumes to match.

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

Sets consumes to match.

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.

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

Sets default flat param object.

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.

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

Sets default support form data.

setDefaultValue(Object) - Method in class org.springdoc.core.ParameterInfo

Sets default value.

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

Sets description.

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

Sets disabled.

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

Sets disable i 18 n.

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

Sets disable swagger default url.

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

Sets display name.

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

Sets display name.

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

Sets display operation id.

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.SpringDocConfigProperties.ModelConverters.PageableConverter

Sets enabled.

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

Sets enabled.

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

Sets enabled.

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

Sets enabled.

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

Sets enabled.

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

Sets enable data rest.

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

Sets enable groovy.

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

Sets enable hateoas.

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

Sets enable javadoc.

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

Sets enable kotlin.

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

Sets enable spring security.

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

setExceptions(Set<Class<?>>) - Method in class org.springdoc.core.MethodAdviceInfo

Sets exceptions.

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

Sets filter.

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

Sets group.

setGroupConfigs(Set<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.

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

Sets headers to match.

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

Sets headers to match.

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

Sets id.

setJavadocReturn(String) - Method in class org.springdoc.core.MethodAttributes

Sets javadoc return value.

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.

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

Sets local storage key.

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.

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

Sets model and view class.

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

Sets model and view class.

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

Sets model converters.

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

Sets name.

setNotRequired(boolean) - Method in class org.springdoc.core.DelegatingMethodParameter

Sets not required.

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

Sets nullable request parameter enabled.

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.

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.

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

Sets pageable converter.

setParameterId(ParameterId) - Method in class org.springdoc.core.ParameterInfo

Sets parameter id.

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.

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

Sets params.

setParamType(String) - Method in class org.springdoc.core.ParameterId

Sets param type.

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

Sets param type.

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.

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

Sets persist authorization.

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

Sets name.

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

Sets name.

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

Sets polymorphic model converter.

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

Sets prefix.

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

Sets locale list to pre-loading.

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

Sets pre loading locales.

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

Sets produces.

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

Sets produces to match.

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

Sets produces to match.

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

Sets query config enabled.

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.

setRequestPart(boolean) - Method in class org.springdoc.core.ParameterInfo

Sets request part.

setRequired(boolean) - Method in class org.springdoc.core.ParameterInfo

Sets required.

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

Sets resolve extensions properties.

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

Sets resolve schema properties.

setResponseEntityExceptionHandlerClass(Class<?>) - Static method in class org.springdoc.core.GenericResponseService

Sets response entity exception handler class.

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

Sets response entity exception handler class.

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

Sets server base url.

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

Sets servers present.

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

Sets local storage key.

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.

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

Sets show oauth 2 endpoints.

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

Sets show spring cloud functions.

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.

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

Sets sort.

setSortConverter(SpringDocConfigProperties.SortConverter) - Method in class org.springdoc.core.SpringDocConfigProperties

Sets sort converter.

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

Sets supported submit methods.

setSyntaxHighlight(SwaggerUiConfigProperties.SyntaxHighlight) - Method in class org.springdoc.core.SwaggerUiConfigProperties

Sets syntaxHighlight.

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

Sets tags sorter.

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

Sets theme.

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

Sets try it out enabled

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

Sets ui root path.

setupModule(Module.SetupContext) - Method in class org.springdoc.core.SpringDocRequiredModule

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(Boolean) - 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.

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

Sets useLocalStorage.

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

Sets use management port.

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

Sets use pkce with authorization code grant.

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

Sets use root path.

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

Sets useSessionStorage.

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

Sets validator url.

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

Sets version.

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

Sets swagger ui version.

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.

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

Sets with credentials.

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.

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

Sets writer wither order by keys.

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

The constant SHOW_COMMON_EXTENSIONS_PROPERTY.

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

The constant SHOW_EXTENSIONS_PROPERTY.

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.

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

The Sort type.

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

Instantiates a new Sort.

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

SortedOpenAPIMixin - Interface in org.springdoc.api.mixins

The interface Sorted open api mixin.

SortedOpenAPIMixin31 - Interface in org.springdoc.api.mixins

The interface Sorted open api mixin 31.

SortedSchemaMixin - Interface in org.springdoc.api.mixins

The interface Sorted schema mixin.

SortedSchemaMixin31 - Interface in org.springdoc.api.mixins

The interface Sorted schema mixin 31.

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

The type Sort response.

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

SortOpenAPIConverter - Class in org.springdoc.core.converters

The Spring Data Sort type model converter.

SortOpenAPIConverter(ObjectMapperProvider) - Constructor for class org.springdoc.core.converters.SortOpenAPIConverter

Instantiates a new Sort open api converter.

sortOutput(ObjectMapper, SpringDocConfigProperties) - Static method in class org.springdoc.core.providers.ObjectMapperProvider

Sort output.

SpecificationStringPropertiesCustomizer - Class in org.springdoc.core.customizers

Allows externalizing strings in generated openapi schema via properties that follow conventional naming similar or identical to openapi schema

SpecificationStringPropertiesCustomizer(PropertyResolver) - Constructor for class org.springdoc.core.customizers.SpecificationStringPropertiesCustomizer

SpecificationStringPropertiesCustomizer(PropertyResolver, String) - Constructor for class org.springdoc.core.customizers.SpecificationStringPropertiesCustomizer

SpecPropertiesCondition - Class in org.springdoc.core

The type Spec properties condition.

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

SpecPropertiesCustomizer - Class in org.springdoc.core.customizers

Allows externalizing strings in generated openapi schema via properties that follow conventional naming similar or identical to openapi schema

SpecPropertiesCustomizer(PropertyResolver) - Constructor for class org.springdoc.core.customizers.SpecPropertiesCustomizer

Instantiates a new Spec properties customizer.

SpecPropertiesCustomizer(PropertyResolver, String) - Constructor for class org.springdoc.core.customizers.SpecPropertiesCustomizer

Instantiates a new Spec properties customizer.

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

Split camel case string.

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

The constant SPRING_MVC_SERVLET_PATH.

SpringCloudFunctionProvider - Class in org.springdoc.core.providers

The type Spring cloud function provider.

SpringCloudFunctionProvider(Optional<FunctionCatalog>, SpringDocConfigProperties) - Constructor for class org.springdoc.core.providers.SpringCloudFunctionProvider

Instantiates a new Spring cloud function provider.

SpringDataWebPropertiesProvider - Class in org.springdoc.core.providers

The type Spring data web properties provider.

SpringDataWebPropertiesProvider(Optional<SpringDataWebProperties>) - Constructor for class org.springdoc.core.providers.SpringDataWebPropertiesProvider

Instantiates a new Spring data web properties provider.

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_CONFIG_PROPERTIES - Static variable in class org.springdoc.core.SpringDocUIConfiguration

The constant SPRINGDOC_CONFIG_PROPERTIES.

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

The constant SPRINGDOC_DEPRECATING_CONVERTER_ENABLED.

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

The constant SPRINGDOC_ENABLE_DEFAULT_API_DOCS.

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

The constant SPRINGDOC_ENABLED.

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

The constant SPRINGDOC_NULLABLE_REQUEST_PARAMETER_ENABLED.

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

The constant SPRINGDOC_PAGEABLE_CONVERTER_ENABLED.

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

The constant SPRINGDOC_POLYMORPHIC_CONVERTER_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_SHOW_OAUTH2_ENDPOINTS - Static variable in class org.springdoc.core.Constants

The constant SPRINGDOC_SHOW_OAUTH2_ENDPOINTS.

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

The constant SPRINGDOC_SHOW_SPRING_CLOUD_FUNCTIONS.

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

The constant SPRINGDOC_SORT_CONVERTER_ENABLED.

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

The constant SPRINGDOC_SPEC_PROPERTIES_PREFIX.

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

The constant SPRINGDOC_SPECIFICATION_STRING_PROPERTIES.

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

The constant SPRINGDOC_SWAGGER_UI_ENABLED.

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

The constant SPRINGDOC_USE_MANAGEMENT_PORT.

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

The constant SPRINGDOC_USE_ROOT_PATH.

SpringdocActuatorBeanFactoryConfigurer - Class in org.springdoc.core

The type Springdoc bean factory configurer.

SpringdocActuatorBeanFactoryConfigurer(List<GroupedOpenApi>) - Constructor for class org.springdoc.core.SpringdocActuatorBeanFactoryConfigurer

Instantiates a new Springdoc actuator bean factory configurer.

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 - Variable in class org.springdoc.core.providers.ActuatorProvider

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.ApiDocs.OpenApiVersion - Enum in org.springdoc.core

The enum OpenApiVersion.

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.ModelConverters.PageableConverter - Class in org.springdoc.core

The type Pageable converter.

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

The type Polymorphic model converter.

SpringDocConfigProperties.SortConverter - Class in org.springdoc.core

The type Sort 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

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

The Spring doc customizers.

SpringDocCustomizers - Class in org.springdoc.core.customizers

The type Spring doc customizers.

SpringDocCustomizers(Optional<List<OpenApiCustomiser>>, Optional<List<OperationCustomizer>>, Optional<List<RouterOperationCustomizer>>, Optional<List<DataRestRouterOperationCustomizer>>, Optional<List<OpenApiMethodFilter>>, Optional<List<GlobalOpenApiCustomizer>>, Optional<List<GlobalOperationCustomizer>>, Optional<List<GlobalOpenApiMethodFilter>>) - Constructor for class org.springdoc.core.customizers.SpringDocCustomizers

Instantiates a new Spring doc customizers.

SpringDocCustomizers(Optional<List<OpenApiCustomiser>>, Optional<List<OperationCustomizer>>, Optional<List<RouterOperationCustomizer>>, Optional<List<OpenApiMethodFilter>>) - Constructor for class org.springdoc.core.customizers.SpringDocCustomizers

Instantiates a new Spring doc customizers.

springDocCustomizers(Optional<List<OpenApiCustomiser>>, Optional<List<OperationCustomizer>>, Optional<List<RouterOperationCustomizer>>, Optional<List<DataRestRouterOperationCustomizer>>, Optional<List<OpenApiMethodFilter>>, Optional<List<GlobalOpenApiCustomizer>>, Optional<List<GlobalOperationCustomizer>>, Optional<List<GlobalOpenApiMethodFilter>>) - Method in class org.springdoc.core.SpringDocConfiguration

Spring doc customizers spring doc customizers.

SpringDocPropertiesUtils - Interface in org.springdoc.core

The interface Spring doc properties utils.

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

The Spring doc providers.

SpringDocProviders - Class in org.springdoc.core

The type Spring doc providers.

SpringDocProviders(Optional<ActuatorProvider>, Optional<CloudFunctionProvider>, Optional<SecurityOAuth2Provider>, Optional<RepositoryRestResourceProvider>, Optional<RouterFunctionProvider>, Optional<SpringWebProvider>, Optional<WebConversionServiceProvider>, ObjectMapperProvider) - Constructor for class org.springdoc.core.SpringDocProviders

Instantiates a new Spring doc providers.

SpringDocRequiredModule - Class in org.springdoc.core

The type Spring doc required module.

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

SpringDocSpecPropertiesConfiguration - Class in org.springdoc.core

The type Spring doc specification string properties configuration.

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

SpringDocUIConfiguration - Class in org.springdoc.core

The type Spring doc Native Configuration.

SpringDocUIConfiguration(Optional<SwaggerUiConfigProperties>) - Constructor for class org.springdoc.core.SpringDocUIConfiguration

Instantiates a new Spring doc hints.

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.

SpringWebProvider - Class in org.springdoc.core.providers

The type Spring web provider.

SpringWebProvider() - Constructor for class org.springdoc.core.providers.SpringWebProvider

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.

style(String) - Method in class org.springdoc.core.fn.builders.encoding.Builder

Style encoding builder.

style(ParameterStyle) - Method in class org.springdoc.core.fn.builders.parameter.Builder

Style parameter builder.

subTypes(Class<?>[]) - Method in class org.springdoc.core.fn.builders.schema.Builder

Sub types schema builder.

summary(String) - Method in class org.springdoc.core.fn.builders.exampleobject.Builder

Summary example object builder.

summary(String) - Method in class org.springdoc.core.fn.builders.operation.Builder

Summary operation builder.

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

The supported try it out methods

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

The constant SWAGGER_CONFIG_FILE.

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

The constant SWAGGER_CONFIG_URL.

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

The constant SWAGGER_INITIALIZER_JS.

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

The constant SWAGGER_INITIALIZER_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_PREFIX - Static variable in class org.springdoc.core.Constants

The constant SWAGGER_UI_PREFIX.

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

The constant SWAGGER_UI_URL.

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

The Swagger config 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.AbstractSwaggerIndexTransformer

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

SwaggerUiConfigProperties.SyntaxHighlight - Class in org.springdoc.core

The type Syntax highlight.

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, String) - Constructor for class org.springdoc.core.AbstractSwaggerUiConfigProperties.SwaggerUrl

Instantiates a new Swagger url.

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

T

tag(String) - Method in class org.springdoc.core.fn.builders.operation.Builder

Tag operation builder.

tags(String[]) - Method in class org.springdoc.core.fn.builders.operation.Builder

Tags operation builder.

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

Apply a sort to the tag list of each API

title(String) - Method in class org.springdoc.core.fn.builders.schema.Builder

Title schema builder.

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

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

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

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

The constant TRACE_METHOD.

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

The constant TRY_IT_ENABLED_PROPERTY.

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

Try it out enabled

type(String) - Method in class org.springdoc.core.fn.builders.schema.Builder

Type schema builder.

U

uniqueItems(boolean) - Method in class org.springdoc.core.fn.builders.arrayschema.Builder

Unique items array schema builder.

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

Update servers open api.

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

The Url.

url(String) - Method in class org.springdoc.core.fn.builders.externaldocumentation.Builder

Url external documentation builder.

url(String) - Method in class org.springdoc.core.fn.builders.server.Builder

Url server builder.

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

The constant URL_PROPERTY.

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

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

The constant VALIDATOR_URL_PROPERTY.

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

URL to validate specs against.

value(String) - Method in class org.springdoc.core.fn.builders.discriminatormapping.Builder

Value discriminator mapping builder.

value(String) - Method in class org.springdoc.core.fn.builders.exampleobject.Builder

Value example object builder.

value(String) - Method in class org.springdoc.core.fn.builders.extensionproperty.Builder

Value extension property builder.

valueOf(String) - Static method in enum org.springdoc.core.SpringDocConfigProperties.ApiDocs.OpenApiVersion

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

values() - Static method in enum org.springdoc.core.SpringDocConfigProperties.ApiDocs.OpenApiVersion

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

variables(Builder) - Method in class org.springdoc.core.fn.builders.server.Builder

Variables server builder.

W

WebConversionServiceProvider - Class in org.springdoc.core.providers

The type Web conversion service provider.

WebConversionServiceProvider() - Constructor for class org.springdoc.core.providers.WebConversionServiceProvider

webEndpointProperties - Variable in class org.springdoc.core.providers.ActuatorProvider

The Web endpoint properties.

WebFluxSupportConverter - Class in org.springdoc.core.converters

The type Web flux support converter.

WebFluxSupportConverter(ObjectMapperProvider) - Constructor for class org.springdoc.core.converters.WebFluxSupportConverter

Instantiates a new Web flux support converter.

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

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

The constant WITH_CREDENTIALS_PROPERTY.

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

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

The With credentials.

writeJsonValue(OpenAPI) - Method in class org.springdoc.api.AbstractOpenApiResource

Write json value string.

writeYamlValue(OpenAPI) - Method in class org.springdoc.api.AbstractOpenApiResource

Write yaml value string.

Y

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

The constant YAML.

yamlMapper() - Method in class org.springdoc.core.providers.ObjectMapperProvider

Yaml mapper object mapper.

yamlMapper() - Method in class org.springdoc.core.SpringDocProviders

Yaml mapper object mapper.

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