cn.fintecher.print.service.summons.config.apidoc.SwaggerConfiguration.java Source code

Introduction

Here is the source code for cn.fintecher.print.service.summons.config.apidoc.SwaggerConfiguration.java

Source

package cn.fintecher.print.service.summons.config.apidoc;

import cn.fintecher.print.config.Constants;
import cn.fintecher.print.service.summons.config.SummonsServiceProperties;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import org.springframework.context.annotation.Profile;
import org.springframework.http.ResponseEntity;
import org.springframework.util.StopWatch;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import static springfox.documentation.builders.PathSelectors.regex;

/**
 * Springfox Swagger configuration.
 * <p>
 * Warning! When having a lot of REST endpoints, Springfox can become a performance issue. In that
 * case, you can use a specific Spring profile for this class, so that only front-end developers
 * have access to the Swagger view.
 */
@Configuration
@EnableSwagger2
@Import(springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration.class)
@Profile(Constants.SPRING_PROFILE_SWAGGER)
public class SwaggerConfiguration {

    private final Logger log = LoggerFactory.getLogger(SwaggerConfiguration.class);

    public static final String DEFAULT_INCLUDE_PATTERN = "/api/.*";

    /**
     * Swagger Springfox configuration.
     *
     * @param summonsServiceProperties the properties of the application
     * @return the Swagger Springfox configuration
     */
    @Bean
    public Docket swaggerSpringfoxDocket(SummonsServiceProperties summonsServiceProperties) {
        log.debug("Starting Swagger");
        StopWatch watch = new StopWatch();
        watch.start();
        Contact contact = new Contact(summonsServiceProperties.getSwagger().getContactName(),
                summonsServiceProperties.getSwagger().getContactUrl(),
                summonsServiceProperties.getSwagger().getContactEmail());

        ApiInfo apiInfo = new ApiInfo(summonsServiceProperties.getSwagger().getTitle(),
                summonsServiceProperties.getSwagger().getDescription(),
                summonsServiceProperties.getSwagger().getVersion(),
                summonsServiceProperties.getSwagger().getTermsOfServiceUrl(), contact,
                summonsServiceProperties.getSwagger().getLicense(),
                summonsServiceProperties.getSwagger().getLicenseUrl());

        Docket docket = new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo).forCodeGeneration(true)
                .genericModelSubstitutes(ResponseEntity.class).select().paths(regex(DEFAULT_INCLUDE_PATTERN))
                .build();
        watch.stop();
        log.debug("Started Swagger in {} ms", watch.getTotalTimeMillis());
        return docket;
    }
}