序
本文主要展示一下如何使用支持WebFlux的Swagger
maven
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>${swagger.version}</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-spring-webflux</artifactId>
<version>${swagger.version}</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>${swagger.version}</version>
</dependency>
- swagger.version目前是3.0.0-SNAPSHOT，因而沒有發(fā)布到maven官方倉庫里頭，需要從jcenter-snapshots中拉取
<repositories>
<repository>
<id>jcenter-snapshots</id>
<name>jcenter</name>
<url>http://oss.jfrog.org/artifactory/oss-snapshot-local/</url>
</repository>
</repositories>
配置
@Configuration
@EnableSwagger2WebFlux
public class SwaggerConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(new ApiInfoBuilder()
.description("example api")
.title("example api")
.version("1.0.0")
.build())
.select()
.apis(RequestHandlerSelectors.basePackage("com.example.controller"))
.paths(PathSelectors.any())
.build();
}
}
- 由于支持了WebFlux，所以之前的@EnableSwagger2就移除掉了，變?yōu)锧EnableSwagger2WebMvc以及@EnableSwagger2WebFlux，這里使用的是@EnableSwagger2WebFlux
小結(jié)
- Spring 5引入了WebFlux艺骂，而當(dāng)前版本的SpringFox Swagger2(
2.9.2)還不支持WebFlux，得使用3.0.0-SNAPSHOT才支持 - 由于是SNAPSHOT版本隆夯，因而沒有發(fā)布到maven官方倉庫里頭钳恕，需要從jcenter-snapshots中拉取，另外要使用支持WebFlux的Swagger2需要引入springfox-spring-webflux依賴
- 由于支持了WebFlux蹄衷，所以之前的@EnableSwagger2就移除掉了忧额，變?yōu)锧EnableSwagger2WebMvc以及@EnableSwagger2WebFlux
