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

Class SwaggerAutoConfiguration

java.lang.Object
org.activiti.cloud.common.swagger.springdoc.conf.SwaggerAutoConfiguration
@AutoConfiguration @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 Details

    • SwaggerAutoConfiguration

      public SwaggerAutoConfiguration()

  • Method Details

    • baseOpenApiBuilder

      @Bean @ConditionalOnMissingBean @DependsOn("swaggerOAuthFlow") public BaseOpenApiBuilder baseOpenApiBuilder(org.springframework.boot.info.BuildProperties buildProperties, io.swagger.v3.oas.models.security.OAuthFlow swaggerOAuthFlow)

    • operationIdCustomizer

      @Bean("globalOpenApiCustomizer") @Primary public org.springdoc.core.customizers.OperationIdCustomizer operationIdCustomizer()

    • 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()

    • ignoredTypesModelConverter

      @Bean @ConditionalOnMissingBean public IgnoredTypesModelConverter ignoredTypesModelConverter()

    • collectionModelConverter

      @Bean @ConditionalOnMissingBean public CollectionModelConverter collectionModelConverter()

    • entityModelConverter

      @Bean @ConditionalOnMissingBean public EntityModelConverter entityModelConverter()

    • pagedModelConverter

      @Bean @ConditionalOnMissingBean public PagedModelConverter pagedModelConverter()