org.springdoc.core

Class SpringDocConfiguration

java.lang.Object

org.springdoc.core.SpringDocConfiguration

@Lazy(value=false)
 @Configuration(proxyBeanMethods=false)
 @ConditionalOnProperty(name="springdoc.api-docs.enabled",
                       matchIfMissing=true)
 @ConditionalOnWebApplication
public class SpringDocConfiguration
extends Object

The type Spring doc configuration.

Author:

bnasslahsen

Constructor Summary

Constructors

Constructor and Description
SpringDocConfiguration()

Method Summary

Modifier and Type

Method and Description

SpringDocCustomizers

springDocCustomizers(Optional<List<OpenApiCustomiser>> openApiCustomizers, Optional<List<OperationCustomizer>> operationCustomizers, Optional<List<RouterOperationCustomizer>> routerOperationCustomizers, Optional<List<DataRestRouterOperationCustomizer>> dataRestRouterOperationCustomizers, Optional<List<OpenApiMethodFilter>> methodFilters, Optional<List<GlobalOpenApiCustomizer>> globalOpenApiCustomizers, Optional<List<GlobalOperationCustomizer>> globalOperationCustomizers, Optional<List<GlobalOpenApiMethodFilter>> globalOpenApiMethodFilters) Spring doc customizers spring doc customizers.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SpringDocConfiguration

public SpringDocConfiguration()

Method Detail

springDocCustomizers

@Bean
 @ConditionalOnMissingBean
 @Lazy(value=false)
public SpringDocCustomizers springDocCustomizers(Optional<List<OpenApiCustomiser>> openApiCustomizers,
                                                                                                      Optional<List<OperationCustomizer>> operationCustomizers,
                                                                                                      Optional<List<RouterOperationCustomizer>> routerOperationCustomizers,
                                                                                                      Optional<List<DataRestRouterOperationCustomizer>> dataRestRouterOperationCustomizers,
                                                                                                      Optional<List<OpenApiMethodFilter>> methodFilters,
                                                                                                      Optional<List<GlobalOpenApiCustomizer>> globalOpenApiCustomizers,
                                                                                                      Optional<List<GlobalOperationCustomizer>> globalOperationCustomizers,
                                                                                                      Optional<List<GlobalOpenApiMethodFilter>> globalOpenApiMethodFilters)

Spring doc customizers spring doc customizers.

Parameters:

openApiCustomizers - the open api customizers

operationCustomizers - the operation customizers

routerOperationCustomizers - the router operation customizers

dataRestRouterOperationCustomizers - the data rest router operation customizers

methodFilters - the method filters

globalOpenApiCustomizers - the global open api customizers

globalOperationCustomizers - the global operation customizers

globalOpenApiMethodFilters - the global open api method filters

Returns:

the spring doc customizers