Swagger基础

介绍

技术 特性 适用场景 说明
Swagger 自动生成接口文档 - 官网
-

注解

注解 说明
@Api 修饰整个类,描述Controller的作用
@ApiOperation 描述一个类的一个方法,或者说一个接口
@ApiParam 单个参数描述
@ApiModel 用对象来接收参数
@ApiProperty 用对象接收参数时,描述对象的一个字段
@ApiResponse HTTP响应其中1个描述
@ApiResponses HTTP响应整体描述
@ApiIgnore 使用该注解忽略这个API
@ApiClass
@ApiError
@ApiErrors
@ApiParamImplicit
@ApiParamsImplicit -

配置

pom.xml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
<!-- 配置Swagger start-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
<exclusions>
<exclusion>
<groupId>io.swagger</groupId>
<artifactId>swagger-annotations</artifactId>
</exclusion>
<exclusion>
<groupId>io.swagger</groupId>
<artifactId>swagger-models</artifactId>
</exclusion>
</exclusions>
</dependency>

<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
<!-- 此处为了修复一个NumberFormatException bug 升级组建版本 -->
<dependency>
<groupId>io.swagger</groupId>
<artifactId>swagger-annotations</artifactId>
<version>1.5.24</version>
</dependency>
<dependency>
<groupId>io.swagger</groupId>
<artifactId>swagger-models</artifactId>
<version>1.5.24</version>
</dependency>
<!-- 配置Swagger 结束-->

生产环境禁用swagger2

方法1(推荐)

1
2
# 开发或测试环境开启,而在生产关闭
@Profile({"dev","test"})

方法二

1
@ConditionalOnProperty(name = "swagger.enable", havingValue = "true")

在测试配置或者开发配置中 添加

1
swagger.enable = true

认证

配置基本认证

1
2


配置Token认证

1
2


配置JWT认证

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
package com.wanglibing.postgresql.config;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
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;

/**
* @author: iamwlb
* @date: 2018/8/31 22:42
*/
@Configuration
@EnableSwagger2
@Profile({"dev","test"})
public class SwaggerConfig {
@Value("${swagger.enable}")
private boolean enableSwagger;

@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.enable(enableSwagger)
.select()
.apis(RequestHandlerSelectors.basePackage("com.wanglibing.postgresql.controller"))
.paths(PathSelectors.any())
.build()
.securitySchemes(Lists.newArrayList(apiKey()));
}

private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("webapi接口文档")
.description("webapi接口文档")
.termsOfServiceUrl("https://www.wanglibing.com")
.contact(new Contact("王丽兵", "www.wanglibing.com", "iamwanglibing@qq.com"))
.licenseUrl("")
.version("1.0")
.build();
}

private ApiKey apiKey() {
return new ApiKey("apikey", "Authorization", "header");
}
}

参考

坚持原创技术分享,您的支持将鼓励我继续创作!
0%