Package io.github.jhipster.config.apidoc

Class SwaggerAutoConfiguration

  • @Configuration
@ConditionalOnWebApplication
@ConditionalOnClass({springfox.documentation.service.ApiInfo.class,springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration.class,javax.servlet.Servlet.class,org.springframework.web.servlet.DispatcherServlet.class,springfox.documentation.spring.web.plugins.Docket.class})
@Profile("swagger")
@AutoConfigureAfter(JHipsterProperties.class)
@EnableSwagger2
@Import(springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration.class)
public class SwaggerAutoConfiguration
extends Object
    Springfox Swagger configuration.

    Warning! When having a lot of REST endpoints, Springfox can become a performance issue. In that case, you can use the "no-swagger" Spring profile, so that this bean is ignored.

    • Constructor Detail

      • SwaggerAutoConfiguration

        public SwaggerAutoConfiguration​(JHipsterProperties jHipsterProperties)

        Constructor for SwaggerAutoConfiguration.

        Parameters:
        jHipsterProperties - a JHipsterProperties object.

    • Method Detail

      • swaggerSpringfoxApiDocket

        @Bean
@ConditionalOnMissingBean(name="swaggerSpringfoxApiDocket")
public springfox.documentation.spring.web.plugins.Docket swaggerSpringfoxApiDocket​(List<SwaggerCustomizer> swaggerCustomizers,
                                                                                   org.springframework.beans.factory.ObjectProvider<springfox.documentation.schema.AlternateTypeRule[]> alternateTypeRules)
        Springfox configuration for the API Swagger docs.
        Parameters:
        swaggerCustomizers - Swagger customizers
        alternateTypeRules - alternate type rules
        Returns:
        the Swagger Springfox configuration

      • jHipsterSwaggerCustomizer

        @Bean
public JHipsterSwaggerCustomizer jHipsterSwaggerCustomizer()
        JHipster Swagger Customizer
        Returns:
        the Swagger Customizer of JHipster

      • swaggerSpringfoxManagementDocket

        @Bean
@ConditionalOnClass(name="org.springframework.boot.actuate.autoconfigure.web.server.ManagementServerProperties")
@ConditionalOnProperty("management.endpoints.web.base-path")
@ConditionalOnExpression("\'${management.endpoints.web.base-path}\'.length() > 0")
@ConditionalOnMissingBean(name="swaggerSpringfoxManagementDocket")
public springfox.documentation.spring.web.plugins.Docket swaggerSpringfoxManagementDocket​(@Value("${spring.application.name:application}")
                                                                                          String appName,
                                                                                          @Value("${management.endpoints.web.base-path}")
                                                                                          String managementContextPath)
        Springfox configuration for the management endpoints (actuator) Swagger docs.
        Parameters:
        appName - the application name
        managementContextPath - the path to access management endpoints
        Returns:
        the Swagger Springfox configuration

      • createDocket

        protected springfox.documentation.spring.web.plugins.Docket createDocket()

        createDocket.

        Returns:
        a Docket object.