導入需要的包
地址
Swagger2需要的包
1. Springfox Swagger2
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>3.0.0</version>
</dependency>
2. Springfox Swagger UI
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>3.0.0</version>
</dependency>
Swagger3需要的包
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
編寫Springboot程序，訪問Swagger-ui.html
在SpringBoot啟動類上添加@EnableSwagger2注解
注意：不管是swagger2還是swagger3，目前的注解都是@EnableSwagger2，還沒有更新。
@EnableSwagger2是springfox提供的液體個注解，代表swagger2相關的技術開啟。
會掃描當前類所在包，及子包中的所有類型中的注解。做swagger文檔的定值。
Swagger2訪問地址：http://localhost:8080/swagger-ui.html
Swagger3訪問地址：http://localhost:8080/swagger-ui/ (注意斜杠)
在項目中添加一個類，來對API文檔主頁的展示信息進行配置
package com.dai.learningsystem.config;
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;
@Configuration
public class SwaggerConfiguration {
/**
* 創建Docket類型的對象。並使用spring容器管理。
* Docket是Swagger中的全局配置對象。
*
* @return
*/
@Bean
public Docket docket() {
Docket docket = new Docket(DocumentationType.SWAGGER_2);
//這里寫的是API文檔頁面上的信息
ApiInfo apiInfo = new ApiInfoBuilder()
.contact(
new Contact(
"YiFan Dai", //是文檔的發布者名稱
"http://alvis.club", //文檔發布者的網站地址。一般是企業網站
"ivan.dai@nf-3.com") //文檔發布者的電子郵箱
)
.title("LS系統開發文檔")
.description("LS系統是個人用於規划學習內容以及即使監控自己學習進度的管理系統。\n" +
"目前用到了SpringBoot+MySql+Swagger3+mybatis等技術。")
.version("1.1")
.build();
//給docket上下文配置api描述信息
docket.apiInfo(apiInfo);
docket = docket
.select()
.apis(RequestHandlerSelectors.basePackage("com.dai.learningsystem.controller"))//用於配置，掃描哪個子包下的注解
.paths(
PathSelectors.regex("/swagger/.*") //使用正則表達式，約束生成API文檔的路徑地址，即只有/swagger/開始的請求才生成API文檔
)
.build();
return docket;
}
}
最終效果如下：
其他常用注解用法
@Api
修飾整個類，用於controller類上
@ApiOperation
描述一個接口，用戶controller方法上
@ApiParam
單個參數描述
@ApiModel
用來對象接收參數,即返回對象
@ApiModelProperty
對象接收參數時，描述對象的字段
@ApiResponse
Http響應其中的描述，在ApiResonse中
@ApiResponses
Http響應所有的描述，用在
@ApiIgnore
忽略這個API
@ApiError
發生錯誤的返回信息
@ApiImplicitParam
一個請求參數
@ApiImplicitParam
多個請求參數
更多使用說明，可參考 Swagger 使用手冊。https://gumutianqi1.gitbooks.io/specification-doc/content/tools-doc/spring-boot-swagger2-guide.html
踩坑
啟動報錯：
org.springframework.context.ApplicationContextException: Failed to start bean 'documentationPluginsBootstrapper'; nested exception is java.lang.NullPointerException
at org.springframework.context.support.DefaultLifecycleProcessor.doStart(DefaultLifecycleProcessor.java:181) ~[spring-context-5.3.13.jar:5.3.13]
at org.springframework.context.support.DefaultLifecycleProcessor.access$200(DefaultLifecycleProcessor.java:54) ~[spring-context-5.3.13.jar:5.3.13]
at org.springframework.context.support.DefaultLifecycleProcessor$LifecycleGroup.start(DefaultLifecycleProcessor.java:356) ~[spring-context-5.3.13.jar:5.3.13]
at java.lang.Iterable.forEach(Iterable.java:75) ~[na:1.8.0_131]
at org.springframework.context.support.DefaultLifecycleProcessor.startBeans(DefaultLifecycleProcessor.java:155) ~[spring-context-5.3.13.jar:5.3.13]
at org.springframework.context.support.DefaultLifecycleProcessor.onRefresh(DefaultLifecycleProcessor.java:123) ~[spring-context-5.3.13.jar:5.3.13]
at org.springframework.context.support.AbstractApplicationContext.finishRefresh(AbstractApplicationContext.java:935) ~[spring-context-5.3.13.jar:5.3.13]
at org.springframework.context.support.AbstractApplicationContext.refresh(AbstractApplicationContext.java:586) ~[spring-context-5.3.13.jar:5.3.13]
at org.springframework.boot.web.servlet.context.ServletWebServerApplicationContext.refresh(ServletWebServerApplicationContext.java:145) ~[spring-boot-2.6.0.jar:2.6.0]
at org.springframework.boot.SpringApplication.refresh(SpringApplication.java:730) [spring-boot-2.6.0.jar:2.6.0]
at org.springframework.boot.SpringApplication.refreshContext(SpringApplication.java:412) [spring-boot-2.6.0.jar:2.6.0]
at org.springframework.boot.SpringApplication.run(SpringApplication.java:302) [spring-boot-2.6.0.jar:2.6.0]
at org.springframework.boot.SpringApplication.run(SpringApplication.java:1301) [spring-boot-2.6.0.jar:2.6.0]
at org.springframework.boot.SpringApplication.run(SpringApplication.java:1290) [spring-boot-2.6.0.jar:2.6.0]
at com.chuci.chucimanagement.ChuCiManagementApplication.main(ChuCiManagementApplication.java:10) [classes/:na]
Caused by: java.lang.NullPointerException: null
at springfox.documentation.spi.service.contexts.Orderings$8.compare(Orderings.java:112) ~[springfox-spi-2.9.2.jar:null]
at springfox.documentation.spi.service.contexts.Orderings$8.compare(Orderings.java:109) ~[springfox-spi-2.9.2.jar:null]
at com.google.common.collect.ComparatorOrdering.compare(ComparatorOrdering.java:37) ~[guava-25.1-jre.jar:na]
at java.util.TimSort.countRunAndMakeAscending(TimSort.java:355) ~[na:1.8.0_131]
at java.util.TimSort.sort(TimSort.java:220) ~[na:1.8.0_131]
at java.util.Arrays.sort(Arrays.java:1438) ~[na:1.8.0_131]
at com.google.common.collect.Ordering.sortedCopy(Ordering.java:852) ~[guava-25.1-jre.jar:na]
at springfox.documentation.spring.web.plugins.WebMvcRequestHandlerProvider.requestHandlers(WebMvcRequestHandlerProvider.java:57) ~[springfox-spring-web-2.9.2.jar:null]
at springfox.documentation.spring.web.plugins.DocumentationPluginsBootstrapper$2.apply(DocumentationPluginsBootstrapper.java:138) ~[springfox-spring-web-2.9.2.jar:null]
at springfox.documentation.spring.web.plugins.DocumentationPluginsBootstrapper$2.apply(DocumentationPluginsBootstrapper.java:135) ~[springfox-spring-web-2.9.2.jar:null]
at com.google.common.collect.Iterators$6.transform(Iterators.java:785) ~[guava-25.1-jre.jar:na]
at com.google.common.collect.TransformedIterator.next(TransformedIterator.java:47) ~[guava-25.1-jre.jar:na]
at com.google.common.collect.TransformedIterator.next(TransformedIterator.java:47) ~[guava-25.1-jre.jar:na]
at com.google.common.collect.Iterators$ConcatenatedIterator.hasNext(Iterators.java:1332) ~[guava-25.1-jre.jar:na]
at com.google.common.collect.ImmutableList.copyOf(ImmutableList.java:270) ~[guava-25.1-jre.jar:na]
at com.google.common.collect.ImmutableList.copyOf(ImmutableList.java:234) ~[guava-25.1-jre.jar:na]
at com.google.common.collect.FluentIterable.toList(FluentIterable.java:617) ~[guava-25.1-jre.jar:na]
at springfox.documentation.spring.web.plugins.DocumentationPluginsBootstrapper.defaultContextBuilder(DocumentationPluginsBootstrapper.java:111) ~[springfox-spring-web-2.9.2.jar:null]
at springfox.documentation.spring.web.plugins.DocumentationPluginsBootstrapper.buildContext(DocumentationPluginsBootstrapper.java:96) ~[springfox-spring-web-2.9.2.jar:null]
at springfox.documentation.spring.web.plugins.DocumentationPluginsBootstrapper.start(DocumentationPluginsBootstrapper.java:167) ~[springfox-spring-web-2.9.2.jar:null]
at org.springframework.context.support.DefaultLifecycleProcessor.doStart(DefaultLifecycleProcessor.java:178) ~[spring-context-5.3.13.jar:5.3.13]
... 14 common frames omitted
解決方法1
springboot版本過高，缺少swagger運行環境，降低到2.5.7即可。
解決方法2
在application.yml中添加一條配置
spring:
mvc:
pathmatch:
matching-strategy: ant_path_matcher
或在application.properties中添加spring.mvc.pathmatch.matching-strategy=ant_path_matcher