SpringBoot集成Swagger3，还想来份离线文档？真酷炫

前言

随着项目架构的演化，前后端分离是不可阻挡的趋势。这种模式的协作在实践的过程中经常会遇到的一个问题就是文档。

在《一位CTO告诉我，项目中至少需要这3类文档》一文我们已经描述了文档的重要性，而接口文档便是其中之一，可以说是必不可少的。

但编写接口文档对开发人员来说是一大难题，而且接口还在不断的变化，还要花费精力去维护接口文档的更新。

既然存在痛点，那么必须会出现解决此痛点的产品，这就是Swagger，目前已经更新到Swagger3版本了。如果你还停留在Swagger2，建议升级到Swagger3，整体UI风格及交互友好了不少。

本篇将围绕Swagger3与SpringBoot的集成和离线文档的生成来进行讲解。

Swagger简介

Swagger是一个规范和完整的框架，用于生成、描述、调用和可视化RESTful风格的Web服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。

官网：https://swagger.io

Swagger解决的痛点

传统方式提供文档有以下痛点：

当引入Swagger之后，以上痛点迎刃而解，同时还带来以下优点：

Swagger3的改变

Swagger3.0的改动，官方文档总结如下几点：

下面就来实战使用一下吧。

SpringBoot集成Swagger3

SpringBoot集成Swagger3与SpringBoot集成其他框架的套路基本一致，通常包括：引入依赖、指定配置文件、创建配置类和使用。

引入依赖

在SpringBoot项目的pom.xml中引入Swagger3依赖：

io.springfoxspringfox-boot-starter3.0.0
 
 

指定配置文件

通常情况下swagger只能在开发环境或测试环境下开启，生产环境下需要进行关闭的。而swagger的开启与关闭可在application.properties中进行配置：

# 生产环境需设置为false
 springfox.documentation.swagger-ui.enabled=true
 

配置类

通过@EnableOpenApi注解启动用Swagger的使用，同时在配置类中对Swagger的通用参数进行配置。

@Configuration
 @EnableOpenApi
 public class Swagger3Config {@Beanpublic Docket createRestApi() {//返回文档摘要信息return new Docket(DocumentationType.OAS_30).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.withMethodAnnotation(Operation.class)).paths(PathSelectors.any()).build().globalRequestParameters(getGlobalRequestParameters()).globalResponses(HttpMethod.GET, getGlobalResponseMessage()).globalResponses(HttpMethod.POST, getGlobalResponseMessage());}/*** 生成接口信息，包括标题、联系人等*/private ApiInfo apiInfo() {return new ApiInfoBuilder().title("Swagger3接口文档").description("如有疑问，可联系二师兄，微信：zhuan2quan").contact(new Contact("二师兄", "https://www.choupangxia.com/", "secbro2@gmail.com")).version("1.0").build();}/*** 封装全局通用参数*/private List getGlobalRequestParameters() {List parameters = new ArrayList<>();parameters.add(new RequestParameterBuilder().name("uuid").description("设备uuid").required(true).in(ParameterType.QUERY).query(q -> q.model(m -> m.scalarModel(ScalarType.STRING))).required(false).build());return parameters;}/*** 封装通用响应信息*/private List getGlobalResponseMessage() {List responseList = new ArrayList<>();responseList.add(new ResponseBuilder().code("404").description("未找到资源").build());return responseList;}
 }
 

通过以上配置已经完成了Spring Boot与Swagger的集成，下面展示一下如何在业务逻辑中进行使用。

业务中使用

创建两个实体类Goods（商品类）和CommonResult（通用返回结果类）。

Goods类：

@ApiModel("商品模型")
 public class Goods {/*** 商品id*/@ApiModelProperty("商品ID")Long goodsId;/*** 商品名称*/@ApiModelProperty("商品名称")private String goodsName;/*** 商品价格*/@ApiModelProperty("商品价格")private BigDecimal price;// 省略getter/setter
 }
 

CommonResult类：

@ApiModel("API通用数据")
 public class CommonResult {/*** 标识代码，0表示成功，非0表示出错*/@ApiModelProperty("标识代码,0表示成功，非0表示出错")private Integer code;/*** 描述信息，通常错时使用*/@ApiModelProperty("错误描述")private String msg;/*** 业务数据*/@ApiModelProperty("业务数据")private T data;public CommonResult(Integer status, String msg, T data) {this.code = status;this.msg = msg;this.data = data;}/*** 成功*/public static  CommonResult success(T data) {return new CommonResult<>(0, "成功", data);}public static  CommonResult success(Integer code, String msg) {return new CommonResult<>(code, msg, null);}/*** 错误*/public static  CommonResult error(int code, String msg) {return new CommonResult<>(code, msg, null);}// 省略getter/setter
 }
 

下面针对Controller层的接口来使用Swagger对应的API。

GoodsController类：

@Api(tags = "商品信息管理接口")
 @RestController
 @RequestMapping("/goods")
 public class GoodsController {@Operation(summary = "单个商品详情")@GetMapping("/findGoodsById")public CommonResult findGoodsById(@Parameter(description = "商品ID,正整数")@RequestParam(value = "goodsId", required = false, defaultValue = "0") Integer goodsId) {System.out.println("根据商品ID=" + goodsId + "查询商品详情");Goods goods = new Goods();goods.setGoodsId(1L);goods.setGoodsName("笔记本");goods.setPrice(new BigDecimal(8888));return CommonResult.success(goods);}
 }
 

OrderController类：

@Api(tags = "订单管理接口")
 @RestController
 @RequestMapping("/order")
 public class OrderController {@Operation(summary = "提交订单")@PostMapping("/order")@ApiImplicitParams({@ApiImplicitParam(name = "userId", value = "用户id", dataTypeClass = Long.class, paramType = "query", example = "123"),@ApiImplicitParam(name = "goodsId", value = "商品id", dataTypeClass = Integer.class, paramType = "query", example = "1")})public CommonResult toBuy(@ApiIgnore @RequestParam Map params) {System.out.println(params);return CommonResult.success("success");}
 }
 

展示效果

完成集成，启动SpringBoot项目，在访问地址：

http://127.0.0.1:8080/swagger-ui/index.html
 

从整体上可以看到如下效果：

具体的商品信息管理接口，可以看到请求参数、返回结果数据结构等信息，点击“Try it out”，可输入参数请求参数，进行接口的调用：

调用之后会返回对应的处理结果：

在最下面的Schemas中还可以看到对应返回结果数据和被Swagger注解的实体类信息。

Swagger3注解使用说明

经过上述实例之后，我们知道大多数API是如何使用的了，这了再汇总一下相关API的功能：

@Api：用在请求的类上，表示对类的说明tags="说明该类的作用，可以在UI界面上看到的注解"value="该参数没什么意义，在UI界面上也看到，所以不需要配置"@ApiOperation：用在请求的方法上，说明方法的用途、作用value="说明方法的用途、作用"notes="方法的备注说明"@ApiImplicitParams：用在请求的方法上，表示一组参数说明@ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面name：参数名value：参数的汉字说明、解释required：参数是否必须传paramType：参数放在哪个地方· header --> 请求参数的获取：@RequestHeader· query --> 请求参数的获取：@RequestParam· path（用于restful接口）--> 请求参数的获取：@PathVariable· body（不常用）· form（不常用）    dataType：参数类型，默认String，其它值dataType="Integer"       defaultValue：参数的默认值@ApiResponses：用在请求的方法上，表示一组响应@ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息code：数字，例如400message：信息，例如"请求参数没填好"response：抛出异常的类@ApiModel：用于响应类上，表示一个返回响应数据的信息（这种一般用在post创建的时候，使用@RequestBody这样的场景，请求参数无法使用@ApiImplicitParam注解进行描述的时候）@ApiModelProperty：用在属性上，描述响应类的属性
 

导出离线文档

Swagger为我们提供了方便的在线文档支持，但某些场景下我们需要把接口文档提供给合作人员，而不是直接给一个地址。此时，我们就需要将接口文档导出为离线文档。

这里我们集成增强文档knife4j来实现离线文档的导出。

添加knife4j依赖

在pom.xml中增加knife4j的依赖：

com.github.xiaoyminknife4j-spring-boot-starter3.0.2
 
 

启动knife4j

在上面配置Swagger的Swagger3Config中添加@EnableKnife4j注解，该注解可以开启knife4j的增强功能。

@EnableKnife4j
 @Configuration
 @EnableOpenApi
 public class Swagger3Config {// ...
 }
 

此时，如果依旧访问http://localhost:8080/swagger-ui/index.html会发现显示并没有变化。这里我们需要访问http://localhost:8088/doc.html。

整个项目源码地址：https://github.com/secbr/springboot-all/tree/master/springboot-swagger3。

展示效果

此时启动项目，访问doc.html之后，你会发现现在文档风格变得非常酷炫。展示几个效果图来看看：

其中在“离线文档”一栏中可以看到四种形式的离线文档下载：Markdown、HTML、Word、OpenAPI。

其中个人感觉HTML格式的文档更具有没敢，也更方便查看，来一张图看看效果。

小结

文档是项目中必须的，但随着开源框架的发展，对技术人员来说文档的痛点也在逐步解决。如果你还处于手写文档的阶段，真的可以尝试一下这类更友好的文档展现形式。

发掘新事物，尝试新鲜事物，才能更快的成长，有更多的Plan B。

---

程序新视界
公众号“ 程序新视界”，一个让你软实力、硬技术同步提升的平台，提供海量资料

博主简介：《SpringBoot技术内幕》技术图书作者，酷爱钻研技术，写技术干货文章。

公众号：「程序新视界」，博主的公众号，欢迎关注~

技术交流：请联系博主微信号：zhuan2quan