前言
学完之前的swagger2之后,发现还有一个新的版本,swagger3,用起来更加的简单,而且是官方的starter。
使用
-
首先导入依赖
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</version> </dependency> -
创建swagger配置类。
package com.yww.config; import org.springframework.context.annotation.Configuration; @Configuration public class swaggerConfig { } -
然后就能访问urlhttp://localhost:8088/swagger-ui/找到文档了。
有很多的配置与swagger2是一样的,就不具体阐述了。
增强
Swagger3还可以使用knife4j来增加Swagger的体验,这个前身是swagger-bootstrap-ui。
官方的文档。https://doc.xiaominfo.com/knife4j/documentation/
可以根据底层的不同来选择依赖,比如使用OpenAPI3结构的可使用以下版本。
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<!--在引用时请在maven中央仓库搜索3.X最新版本号-->
<version>3.0.2</version>
</dependency>
使用后也是访问doc.html就能看到。
knife4j还有增强的特性,可以参考https://doc.xiaominfo.com/knife4j/documentation/enhance.html来开启增强模式。