Swagger2 WebFlux小试牛刀

忘是亡心i 2022-10-01 08:53 224阅读 0赞

## 序 ##

本文主要展示一下如何使用支持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，因而没有发布到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 ##

*  [springfox docs snapshot][]
 *  [spring-boot-webflux-swagger-starter][]
 *  [Maven repository for springfox-spring-webflux ? \#2939][Maven repository for springfox-spring-webflux _ _2939]

转载于:https://juejin.im/post/5cae04a55188251acb52f9d4

[springfox docs snapshot]: https://link.juejin.im?target=https%3A%2F%2Fspringfox.github.io%2Fspringfox%2Fdocs%2Fsnapshot%2F%23introduction
[spring-boot-webflux-swagger-starter]: https://link.juejin.im?target=https%3A%2F%2Fgithub.com%2Fpgilad%2Fspring-boot-webflux-swagger-starter
[Maven repository for springfox-spring-webflux _ _2939]: https://link.juejin.im?target=https%3A%2F%2Fgithub.com%2Fspringfox%2Fspringfox%2Fissues%2F2939