Package id.devcode.openapi

Class OpenApiAutoConfiguration

java.lang.Object

id.devcode.openapi.OpenApiAutoConfiguration

@AutoConfiguration
@EnableConfigurationProperties(OpenApiProperties.class)
@ConditionalOnWebApplication(type=SERVLET)
@ConditionalOnProperty(name="springdoc.api-docs.enabled",
                       matchIfMissing=true)
@ConditionalOnClass({io.swagger.v3.oas.models.Components.class,io.swagger.v3.oas.models.parameters.Parameter.class,io.swagger.v3.oas.models.security.SecurityScheme.class})
@PropertySource("classpath:/springdoc-openapi.properties")
public class OpenApiAutoConfiguration
extends Object

OpenApi auto configuration

Version:

1.0.0

Author:

laminalfalah on 01/09/25

Constructor Summary

Constructors

Constructor	Description
OpenApiAutoConfiguration()	Default constructor for auto configuration

Method Summary

Modifier and Type	Method	Description
ActuatorFactoryBean	actuatorFactoryBean(io.swagger.v3.oas.models.Components components, OpenApiProperties properties, String actuator)	Actuator factory bean.
ComponentFactoryBean	components(org.springframework.context.ApplicationContext context)	Component factory bean.
ExtensionFactoryBean	extensionFactoryBean(io.swagger.v3.oas.models.Components components, OpenApiProperties properties, String actuator)	Extension factory bean.
OpenApiFactoryBean	openApiFactoryBean(io.swagger.v3.oas.models.Components components, OpenApiProperties properties)	Open api factory bean.

Methods inherited from class java.lang.Object

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

Constructor Details

OpenApiAutoConfiguration

public OpenApiAutoConfiguration()

Default constructor for auto configuration

Method Details

components

@Bean
public ComponentFactoryBean components(org.springframework.context.ApplicationContext context)

Component factory bean.

Parameters:

context - application context

Returns:

ComponentFactoryBean

openApiFactoryBean

@Bean
public OpenApiFactoryBean openApiFactoryBean(io.swagger.v3.oas.models.Components components,
 OpenApiProperties properties)

Open api factory bean.

Parameters:

components - components

properties - properties

Returns:

OpenApiFactoryBean

extensionFactoryBean

@Bean
@ConditionalOnMissingBean
@ConditionalOnClass(OpenApiProperties.class)
@ConditionalOnProperty(name="springdoc.api-docs.groups.enabled",
                       matchIfMissing=true)
public ExtensionFactoryBean extensionFactoryBean(io.swagger.v3.oas.models.Components components,
 OpenApiProperties properties,
 @Value("${management.endpoints.web.base-path:/actuator}")
 String actuator)

Extension factory bean.

Parameters:

components - components

properties - properties

actuator - actuator path

Returns:

ExtensionFactoryBean

actuatorFactoryBean

@Bean
@ConditionalOnMissingBean
@ConditionalOnClass(name="org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointAutoConfiguration")
@ConditionalOnProperty(name={"springdoc.show-actuator","springdoc.api-docs.groups.enabled"},
                       matchIfMissing=true)
public ActuatorFactoryBean actuatorFactoryBean(io.swagger.v3.oas.models.Components components,
 OpenApiProperties properties,
 @Value("${management.endpoints.web.base-path:/actuator}")
 String actuator)

Actuator factory bean.

Parameters:

components - components

properties - properties

actuator - actuator path

Returns:

ActuatorFactoryBean