org.springdoc.core

Class SpringDocConfiguration

java.lang.Object

org.springdoc.core.SpringDocConfiguration

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

Constructor Summary

Constructors

Constructor and Description
SpringDocConfiguration()

Method Summary

Modifier and Type	Method and Description
ReturnTypeParser	genericReturnTypeParser()
ModelConverterRegistrar	modelConverterRegistrar(Optional<List<io.swagger.v3.core.converter.ModelConverter>> modelConverters)
OpenAPIBuilder	openAPIBuilder(Optional<io.swagger.v3.oas.models.OpenAPI> openAPI, org.springframework.context.ApplicationContext context, org.springdoc.core.SecurityParser securityParser, SpringDocConfigProperties springDocConfigProperties, Optional<List<OpenApiBuilderCustomiser>> openApiBuilderCustomisers)
OperationBuilder	operationBuilder(GenericParameterBuilder parameterBuilder, RequestBodyBuilder requestBodyBuilder, org.springdoc.core.SecurityParser securityParser, PropertyResolverUtils propertyResolverUtils)
GenericParameterBuilder	parameterBuilder(PropertyResolverUtils propertyResolverUtils)
OpenApiCustomiser	propertiesResolverForSchema(PropertyResolverUtils propertyResolverUtils, OpenAPIBuilder openAPIBuilder)
PropertyResolverUtils	propertyResolverUtils(org.springframework.beans.factory.config.ConfigurableBeanFactory factory)
RequestBodyBuilder	requestBodyBuilder(GenericParameterBuilder parameterBuilder)
org.springdoc.core.SecurityParser	securityParser(PropertyResolverUtils propertyResolverUtils)

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

openAPIBuilder

@Bean
public OpenAPIBuilder openAPIBuilder(Optional<io.swagger.v3.oas.models.OpenAPI> openAPI,
                                            org.springframework.context.ApplicationContext context,
                                            org.springdoc.core.SecurityParser securityParser,
                                            SpringDocConfigProperties springDocConfigProperties,
                                            Optional<List<OpenApiBuilderCustomiser>> openApiBuilderCustomisers)

modelConverterRegistrar

@Bean
public ModelConverterRegistrar modelConverterRegistrar(Optional<List<io.swagger.v3.core.converter.ModelConverter>> modelConverters)

operationBuilder

@Bean
 @ConditionalOnWebApplication
public OperationBuilder operationBuilder(GenericParameterBuilder parameterBuilder,
                                                                               RequestBodyBuilder requestBodyBuilder,
                                                                               org.springdoc.core.SecurityParser securityParser,
                                                                               PropertyResolverUtils propertyResolverUtils)

propertyResolverUtils

@Bean
public PropertyResolverUtils propertyResolverUtils(org.springframework.beans.factory.config.ConfigurableBeanFactory factory)

requestBodyBuilder

@Bean
 @ConditionalOnWebApplication
public RequestBodyBuilder requestBodyBuilder(GenericParameterBuilder parameterBuilder)

securityParser

@Bean
public org.springdoc.core.SecurityParser securityParser(PropertyResolverUtils propertyResolverUtils)

genericReturnTypeParser

@Bean
public ReturnTypeParser genericReturnTypeParser()

parameterBuilder

@Bean
public GenericParameterBuilder parameterBuilder(PropertyResolverUtils propertyResolverUtils)

propertiesResolverForSchema

@Bean
 @ConditionalOnProperty(value="springdoc.api-docs.resolve-schema-properties")
public OpenApiCustomiser propertiesResolverForSchema(PropertyResolverUtils propertyResolverUtils,
                                                                                                                                           OpenAPIBuilder openAPIBuilder)