Swagger2 WebFlux小試牛刀

時間 2019-11-06

標籤 swagger2 swagger webflux 小試牛刀简体版

原文原文鏈接

序

本文主要展現一下如何使用支持WebFlux的Swaggergit

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，於是沒有發佈到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就移除掉了，變爲@EnableSwagger2WebMvc以及@EnableSwagger2WebFlux，這裏使用的是@EnableSwagger2WebFlux

小結

Spring 5引入了WebFlux，而當前版本的SpringFox Swagger2(2.9.2)還不支持WebFlux，得使用3.0.0-SNAPSHOT才支持
因爲是SNAPSHOT版本，於是沒有發佈到maven官方倉庫裏頭，須要從jcenter-snapshots中拉取，另外要使用支持WebFlux的Swagger2須要引入springfox-spring-webflux依賴
因爲支持了WebFlux，因此以前的@EnableSwagger2就移除掉了，變爲@EnableSwagger2WebMvc以及@EnableSwagger2WebFlux

doc

相關標籤/搜索

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。