Package org.activiti.cloud.common.swagger.springdoc.conf

Class SwaggerAutoConfiguration

java.lang.Object

org.activiti.cloud.common.swagger.springdoc.conf.SwaggerAutoConfiguration

@Configuration
@PropertySource("classpath:swagger-config.properties")
public class SwaggerAutoConfiguration
extends Object

Provides base springdoc configuration for swagger auto-generated specification file. It provides swagger specification file under default path `springdoc/v3/api-docs` and provides specification for Alfresco MediaType format This configuration is not self-contained: when adding this as dependency provide following properties

     springdoc.packages-to-scan=[base-package-to-scan]
     springdoc.api-docs.path=[path-to-custom-api-docs]
 

and a bean for OpenApi:

     @Bean
     public OpenAPI baseOpenApi(BaseOpenApiBuilder baseOpenApiBuilder) {
         return baseOpenApiBuilder.build("title", "service-url-prefix");
     }
 

Constructor Summary

Constructors

Constructor	Description
SwaggerAutoConfiguration()

Method Summary

Modifier and Type	Method	Description
BaseOpenApiBuilder	baseOpenApiBuilder(org.springframework.boot.info.BuildProperties buildProperties)
ErrorResponsesOperationCustomizer	errorResponsesOperationCustomizer()
NamingOperationCustomizer	namingOperationCustomizer()
PathPrefixOpenApiCustomizer	pathPrefixCustomizer()
SchemaTitleOpenApiCustomizer	schemaTitleOpenApiCustomizer()
SecurityItemOperationCustomizer	securityItemOperationCustomizer()
SummaryOperationCustomizer	summaryOperationCustomizer()

Methods inherited from class java.lang.Object

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

Constructor Detail

SwaggerAutoConfiguration

public SwaggerAutoConfiguration()

Method Detail

baseOpenApiBuilder

@Bean
@ConditionalOnMissingBean
public BaseOpenApiBuilder baseOpenApiBuilder(org.springframework.boot.info.BuildProperties buildProperties)

pathPrefixCustomizer

@Bean
@ConditionalOnMissingBean
public PathPrefixOpenApiCustomizer pathPrefixCustomizer()

errorResponsesOperationCustomizer

@Bean
@ConditionalOnMissingBean
public ErrorResponsesOperationCustomizer errorResponsesOperationCustomizer()

summaryOperationCustomizer

@Bean
@ConditionalOnMissingBean
public SummaryOperationCustomizer summaryOperationCustomizer()

securityItemOperationCustomizer

@Bean
@ConditionalOnMissingBean
public SecurityItemOperationCustomizer securityItemOperationCustomizer()

schemaTitleOpenApiCustomizer

@Bean
@ConditionalOnMissingBean
public SchemaTitleOpenApiCustomizer schemaTitleOpenApiCustomizer()

namingOperationCustomizer

@Bean
@ConditionalOnMissingBean
public NamingOperationCustomizer namingOperationCustomizer()