springboot 添加swagger

在pom.xml文件中添加:

 1         <!-- swagger -->
 2         <dependency>
 3             <groupId>io.springfox</groupId>
 4             <artifactId>springfox-swagger2</artifactId>
 5             <version>2.9.2</version>
 6         </dependency>
 7         <dependency>
 8             <groupId>io.springfox</groupId>
 9             <artifactId>springfox-swagger-ui</artifactId>
10             <version>2.9.2</version>
11         </dependency>

添加swagger配置类

 1 import io.swagger.annotations.Api;
 4 import org.springframework.context.annotation.Bean;
 5 import org.springframework.context.annotation.Configuration;
 6 import springfox.documentation.builders.ApiInfoBuilder;
 7 import springfox.documentation.builders.ParameterBuilder;
 8 import springfox.documentation.builders.PathSelectors;
 9 import springfox.documentation.builders.RequestHandlerSelectors;
10 import springfox.documentation.schema.ModelRef;
11 import springfox.documentation.service.ApiInfo;
12 import springfox.documentation.service.Parameter;
13 import springfox.documentation.spi.DocumentationType;
14 import springfox.documentation.spring.web.plugins.Docket;
15 import springfox.documentation.swagger2.annotations.EnableSwagger2;
16 
17 import java.util.ArrayList;
18 import java.util.List;
19 
20 /**
21  * swagger配置文档
22  * @author sunxun
23  */
24 @Configuration
25 @EnableSwagger2
26 public class SwaggerConfig2 {
27 
28     @Bean
29     public Docket createRestApi() {
30         //在配置好的配置类中增加此段代码即可
31         ParameterBuilder ticketPar = new ParameterBuilder();
32         List<Parameter> pars = new ArrayList<Parameter>();
33                 //名称
34         ticketPar.name("ACCESS_TOKEN")
35                 //表示描述
36                 .description("登录校验")
37                 .modelRef(new ModelRef("string"))
38                 .parameterType("header")
39                 //是否必填
40                 .required(false).
41                 //默认值
42                 defaultValue("")
43                 .build();
44         pars.add(ticketPar.build());
45         return new Docket(DocumentationType.SWAGGER_2)
46                 .apiInfo(apiInfo())
47                 .select()
48                 // 只扫描带api注解的ID
49                 .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
50                 //这里采用包扫描的方式来确定要显示的接口
51 //                .apis(RequestHandlerSelectors.basePackage("com.cn.controller"))
52                 .paths(PathSelectors.any())
53                 .build()
54                 .globalOperationParameters(pars)
55                 .apiInfo(apiInfo());
56     }
57 
58     private ApiInfo apiInfo() {
59         return new ApiInfoBuilder()
60                 .title("API")
61                 .description("对外接口")
62                 .termsOfServiceUrl("")
63                 .version("1.00")
64                 .build();
65     }
66 }

在springboot 启动器上添加扫描包注解

1 @ComponentScan("com.cn")
上一篇:解决jsonObject.put("key",null)时,值为null的属性key会消失


下一篇:Java Api 文档