学Swagger，这篇文章就够了

本文链接：https://blog.csdn.net/weixin_44861399/article/details/107348497

文章目录

为什么要学swagger

自动生成API接口文档！！！
由于前后端无法做到及时协商，尽早解决，沟通不便，开发迟缓
swagger号称世界上最流行的API框架
Restful Api 文档在线自动生成器，可以直接运行，在线测试API

SpringBoot集成Swagger

初始配置

添加maven依赖

<!--swagger依赖-->
<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger2</artifactId>
   <version>2.9.2</version>
</dependency>
<!--ui界面，可选有多种-->
<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger-ui</artifactId>
   <version>2.9.2</version>
</dependency>

编写一个Controller，并确保运行成功。
编写配置类SwaggerConfig

@Configuration //配置类
@EnableSwagger2// 开启Swagger2的自动配置
public class SwaggerConfig {  
	@Bean //配置docket以配置Swagger具体参数
	public Docket docket() {
   		return new Docket(DocumentationType.SWAGGER_2);
	}
}

通过apiInfo()属性配置文档信息

@Configuration //配置类
@EnableSwagger2// 开启Swagger2的自动配置
public class SwaggerConfig {  
	@Bean //配置docket以配置Swagger具体参数
	public Docket docket() {
   		return new Docket(DocumentationType.SWAGGER_2);
	}
	
//配置文档信息
	private ApiInfo apiInfo() {
   		Contact contact = new Contact("联系人名字", "http://xxx.xxx.com/联系人访问链接", "联系人邮箱");
   		return new ApiInfo(
           "Swagger学习", // 标题
           "学习演示如何配置Swagger", // 描述
           "v1.0", // 版本
           "http://terms.service.url/组织链接", // 组织链接
           contact, // 联系人信息
           "Apach 2.0 许可", // 许可
           "许可链接", // 许可连接
           new ArrayList<>()// 扩展
  );
}
}

Docket 实例关联上 apiInfo()

@Bean
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());
}

启动，访问 http://localhost:8080/swagger-ui.html ，如图所示：

在这里插入图片描述

配置扫描接口

构建Docket时用select()方法，通过包路径配置扫描接口。

@Bean
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2)
      .apiInfo(apiInfo())
      .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
      .apis(RequestHandlerSelectors.basePackage("com.daq.controller"))
      .build();
}

还可以通过配置其他方式扫描接口

// 扫描所有，项目中的所有接口都会被扫描到
any() 
// 不扫描接口
none() 
// 通过方法上的注解扫描，如withMethodAnnotation(GetMapping.class)只扫描get请求
withMethodAnnotation(final Class<? extends Annotation> annotation)
// 通过类上的注解扫描，如.withClassAnnotation(Controller.class)只扫描有controller注解的类中的接口
withClassAnnotation(final Class<? extends Annotation> annotation)
// 根据包路径扫描接口
basePackage(final String basePackage)

还可以配置接口扫描过滤，不扫描哪些包

@Bean
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2)
      .apiInfo(apiInfo())
      .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
      .apis(RequestHandlerSelectors.basePackage("com.daq.controller"))
       // 配置如何通过path过滤,即这里只扫描请求以/daq开头的接口
      .paths(PathSelectors.ant("/daq/**"))
      .build();
}

包扫描过滤还有以下可选值

any() // 任何请求都扫描
none() // 任何请求都不扫描
regex(final String pathRegex) // 通过正则表达式控制
ant(final String antPattern) // 通过ant()控制

Swagger开关

通过enable()方法配置是否启用swagger，如果是false，swagger将不能在浏览器中访问了。

@Bean
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2)
      .apiInfo(apiInfo())
      .enable(false) //配置是否启用Swagger，如果是false，在浏览器将无法访问
      .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
      .apis(RequestHandlerSelectors.basePackage("com.daq.controller"))
       // 配置如何通过path过滤,即这里只扫描请求以/daq开头的接口
      .paths(PathSelectors.ant("/daq/**"))
      .build();
}

当项目处于test、dev环境时显示swagger，处于prod时不显示。

@Bean
public Docket docket(Environment environment) {
   Profiles of = Profiles.of("dev", "test");// 设置要显示swagger的环境
   boolean b = environment.acceptsProfiles(of);// 判断当前是否处于该环境,通过 enable() 接收此参数判断是否要显示
   return new Docket(DocumentationType.SWAGGER_2)
      .apiInfo(apiInfo())
      .enable(b) //配置是否启用Swagger，如果是false，在浏览器将无法访问
      .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
      .apis(RequestHandlerSelectors.basePackage("com.daq.controller"))
       // 配置如何通过path过滤,即这里只扫描请求以/daq开头的接口
      .paths(PathSelectors.ant("/daq/**"))
      .build();
}

API分组配置

在这里插入图片描述

如果没有配置分组，默认是default，通过groupName()方法即可配置分组：

@Bean
public Docket docket(Environment environment) {
   return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
      .groupName("hello") // 配置分组
       // 省略配置....
}

配置多个分组只需要配置多个docket即可

@Bean
public Docket docket1(){
   return new Docket(DocumentationType.SWAGGER_2).groupName("group1");
}
@Bean
public Docket docket2(){
   return new Docket(DocumentationType.SWAGGER_2).groupName("group2");
}
@Bean
public Docket docket3(){
   return new Docket(DocumentationType.SWAGGER_2).groupName("group3");
}

实体配置

新建一个实体类

@ApiModel("用户实体")
public class User {
   @ApiModelProperty("用户名")
   public String username;
   @ApiModelProperty("密码")
   public String password;
}

在controller中编写接口

@RequestMapping("/getUser")
public User getUser(){
   return new User();
}

注意：

并不是因为@ApiModel这个注解让实体显示在这里了，而是只要出现在接口方法的返回值上的实体都会显示在这里，而@ApiModel和@ApiModelProperty这两个注解只是为实体添加注释的。
@ApiModel为类添加注释
java@ApiModelProperty为类属性添加注释

访问如图所示：

在这里插入图片描述

常用注解

Swagger注解	简单说明
@Api(tags = “xxx模块说明”)	作用在模块类上
@ApiOperation(“xxx接口说明”)	作用在接口方法上
@ApiModel(“xxxPOJO说明”)	作用在模型类上：如VO、BO
@ApiModelProperty(value = “xxx属性说明”,hidden = true)	作用在类方法和属性上，hidden设置为true可以隐藏该属性
@ApiParam(“xxx参数说明”)	作用在参数、方法和字段上，类似@ApiModelProperty

其他皮肤

我们可以导入不同的包实现不同的皮肤定义：

swagger-ui，访问 http://localhost:8080/swagger-ui.html

<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger-ui</artifactId>
   <version>2.9.2</version>
</dependency>

bootstrap-ui ，访问 http://localhost:8080/doc.html

<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>swagger-bootstrap-ui</artifactId>
   <version>1.9.1</version>
</dependency>

Layui-ui 访问 http://localhost:8080/docs.html

<dependency>
   <groupId>com.github.caspar-chen</groupId>
   <artifactId>swagger-ui-layer</artifactId>
   <version>1.1.3</version>
</dependency>

mg-ui 访问 http://localhost:8080/document.html

<dependency>
   <groupId>com.zyplayer</groupId>
   <artifactId>swagger-mg-ui</artifactId>
   <version>1.0.6</version>
</dependency>

总结

Swagger是个优秀的工具，相较于传统的要先出Word接口文档再测试的方式，显然这样也更符合现在的快速迭代开发。但是出于安全考虑以及节约运行时内存，在正式环境要记得关闭Swagger。