Package org.springdoc.core.configuration

Class SpringDocConfiguration

java.lang.Object

org.springdoc.core.configuration.SpringDocConfiguration

@Lazy(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	Description
SpringDocConfiguration()

Method Summary

Modifier and Type	Method	Description
SpringDocCustomizers	springDocCustomizers(Optional<List<OpenApiCustomizer>> 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 Details

SpringDocConfiguration

public SpringDocConfiguration()

Method Details

springDocCustomizers

@Bean
@ConditionalOnMissingBean
@Lazy(false)
public SpringDocCustomizers springDocCustomizers(Optional<List<OpenApiCustomizer>> 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