Spring Boot : Swagger 2

　　每次修改完代码需要找原本的API时楼主的内心是痛苦的，因为一般情况下都找不到，需要重新写一份。如果使用Swagger的话，只要加几个注解就可以实时生成最新的在线API文档，而且不仅仅是文档，同时支持API接口的测试。下面呢，给大家分享一下Spring Boot 集成 Swagger 的步骤。

一、引入jar包

 1 　　　　　<!-- Swagger2核心包-->
 2         <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
 3         <dependency>
 4             <groupId>io.springfox</groupId>
 5             <artifactId>springfox-swagger2</artifactId>
 6             <version>2.7.0</version>
 7         </dependency>
 8 
 9         <!-- Swagger2 UI包，前端展示API文档 -->
10         <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
11         <dependency>
12             <groupId>io.springfox</groupId>
13             <artifactId>springfox-swagger-ui</artifactId>
14             <version>2.7.0</version>
15         </dependency>

二、配置SwaggerConfig

 1 package com.bjgoodwill.oip.major.config;
 2 
 3 import org.springframework.context.annotation.Bean;
 4 import org.springframework.context.annotation.Configuration;
 5 import springfox.documentation.builders.ApiInfoBuilder;
 6 import springfox.documentation.builders.PathSelectors;
 7 import springfox.documentation.builders.RequestHandlerSelectors;
 8 import springfox.documentation.service.ApiInfo;
 9 import springfox.documentation.spi.DocumentationType;
10 import springfox.documentation.spring.web.plugins.Docket;
11 import springfox.documentation.swagger2.annotations.EnableSwagger2;
12 
13 /**
14  * @Description： swagger配置文件
15  * @Date 2018/7/13 10:50
16  * @Author HQueen
17  */
18 @Configuration
19 @EnableSwagger2
20 public class SwaggerConfig {
21     @Bean
22     public Docket api() {
23         return new Docket(DocumentationType.SWAGGER_2)
24                 .apiInfo(apiInfo())
25                 .select()
26                 .apis(RequestHandlerSelectors.basePackage("com.queeen.major"))
27                 .paths(PathSelectors.any())
28                 .build();
29     }
30 
31     private ApiInfo apiInfo() {
32         return new ApiInfoBuilder()
33                 .title("API文档")
34                 .build();
35     }
36 }

View Code