Package tech.jhipster.config.apidoc

Class SpringfoxAutoConfiguration

  • @Configuration
@ConditionalOnWebApplication
@ConditionalOnClass({springfox.documentation.service.ApiInfo.class,springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration.class,springfox.documentation.spring.web.plugins.Docket.class})
@Profile("api-docs")
@AutoConfigureAfter(JHipsterProperties.class)
@Import({springfox.documentation.oas.configuration.OpenApiDocumentationConfiguration.class,springfox.documentation.swagger2.configuration.Swagger2DocumentationConfiguration.class,springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration.class})
public class SpringfoxAutoConfiguration
extends Object
    Springfox OpenAPI configuration.

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

    • Constructor Detail

      • SpringfoxAutoConfiguration

        public SpringfoxAutoConfiguration​(JHipsterProperties jHipsterProperties)

        Constructor for SpringfoxAutoConfiguration.

        Parameters:
        jHipsterProperties - a JHipsterProperties object.

    • Method Detail

      • openAPISpringfoxApiDocket

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

      • jHipsterSpringfoxCustomizer

        @Bean
public JHipsterSpringfoxCustomizer jHipsterSpringfoxCustomizer()
        JHipster Springfox Customizer
        Returns:
        the Sringfox Customizer of JHipster

      • openAPISpringfoxManagementDocket

        @Bean
@ConditionalOnClass(name="org.springframework.boot.actuate.autoconfigure.web.server.ManagementServerProperties")
@ConditionalOnMissingBean(name="openAPISpringfoxManagementDocket")
public springfox.documentation.spring.web.plugins.Docket openAPISpringfoxManagementDocket​(@Value("${spring.application.name:application}")
                                                                                          String appName)
        Springfox configuration for the management endpoints (actuator) OpenAPI docs.
        Parameters:
        appName - the application name
        Returns:
        the Springfox configuration

      • createDocket

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

        createDocket.

        Returns:
        a Docket object.