springboot中swagger快速啟動流程

/**
 * Swagger2配置類
 * 在與spring boot集成時，放在與Application.java同級的目錄下。
 * 通過@Configuration注解，讓Spring來加載該類配置。
 * 再通過@EnableSwagger2注解來啟用Swagger2。
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {
  
  /**
   * 創(chuàng)建API應(yīng)用
   * apiInfo() 增加API相關(guān)信息
   * 通過select()函數(shù)返回一個ApiSelectorBuilder實(shí)例,用來控制哪些接口暴露給Swagger來展現(xiàn)，
   * 本例采用指定掃描的包路徑來定義指定要建立API的目錄。
   * 
   * @return
   */
  @Bean
  public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select()
        .apis(RequestHandlerSelectors.basePackage("com.swaggerTest.controller"))
        .paths(PathSelectors.any())
        .build();
  }
  
  /**
   * 創(chuàng)建該API的基本信息（這些基本信息會展現(xiàn)在文檔頁面中）
   * 訪問地址：http://項(xiàng)目實(shí)際地址/swagger-ui.html
   * @return
   */
  private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
        .title("Spring Boot中使用Swagger2構(gòu)建RESTful APIs")
        .description("更多請關(guān)注http://www.baidu.com")
        .termsOfServiceUrl("http://www.baidu.com")
        .contact("sunf")
        .version("1.0")
        .build();
  }
}

@Configuration
@PropertySource(value = "classpath:swagger.properties", ignoreResourceNotFound = true, encoding = "UTF-8")
@EnableConfigurationProperties(SwaggerProperties.class)
public class SwaggerConfig {
 @Resource
 private SwaggerProperties swaggerProperties;
 @Bean
 public Docket buildDocket() {
  return new Docket(DocumentationType.SWAGGER_2)
    .apiInfo(buildApiInf())
    .select()
    .apis(RequestHandlerSelectors.basePackage(""))
    .paths(PathSelectors.any())
    .build();
 }
 private ApiInfo buildApiInf() {
  return new ApiInfoBuilder()
    .title(swaggerProperties.getTitle())
    .description(swaggerProperties.getDescription())
    .termsOfServiceUrl(swaggerProperties.getTermsOfServiceUrl())
    .contact(new Contact("skyworth", swaggerProperties.getTermsOfServiceUrl(), ""))
    .version(swaggerProperties.getVersion())
    .build();
 }
}

@Data
@ToString
@ConfigurationProperties(SwaggerProperties.PREFIX)
public class SwaggerProperties {
 public static final String PREFIX = "swagger";
 /**
  * 文檔掃描包路徑
  */
 private String basePackage = "";
 /**
  * title 如: 用戶模塊系統(tǒng)接口詳情
  */
 private String title = "深蘭云平臺系統(tǒng)接口詳情";
 /**
  * 服務(wù)文件介紹
  */
 private String description = "在線文檔";
 /**
  * 服務(wù)條款網(wǎng)址
  */
 private String termsOfServiceUrl = "https://www.deepblueai.com/";
 /**
  * 版本
  */
 private String version = "V1.0";
}

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
 io.purge.swagger.SwaggerConfig

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Import(SwaggerConfig.class)
@EnableSwagger2
public @interface EnableSwaggerPlugins {

}

<dependency>
 <groupId>com.purge.swagger</groupId>
 <artifactId>swagger-spring-boot-starter<factId>
 <version>0.1.0.RELEASE</version>
</dependency>

swagger.basePackage="swagger掃描項(xiàng)目包路徑"
swagger.title="swagger網(wǎng)頁顯示標(biāo)題"
swagger.description="swagger網(wǎng)頁顯示介紹"

@EnableSwaggerPlugins
@SpringBootApplication
public class FrontDemoApplication {
 public static void main(String[] args) {
  SpringApplication.run(FrontDemoApplication.class, args);
 }
}