Webflux应用引入swagger

一 背景

spring boot webmvc项目重构为webflux项目，原swagger依赖由于依赖了servlet，并不能兼容webflux项目。

二 pom依赖

去掉旧的swagger依赖，并增加以下swagger依赖

   <properties>
       ...
       <swagger.version>3.0.0-SNAPSHOT</swagger.version>
       ...
   </properties>
...
    <dependency>
           <groupId>io.springfox</groupId>
           <artifactId>springfox-swagger-ui</artifactId>
           <version>${swagger.version}</version>
       </dependency>

       <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>
...
   <repositories>
       <repository>
           <id>spring-snapshots</id>
           <url>http://repo.spring.io/snapshot</url>
           <snapshots>
               <enabled>true</enabled>
           </snapshots>
       </repository>
       <repository>
           <id>swagger-snapshots</id>
           <url>http://oss.jfrog.org/artifactory/oss-snapshot-local</url>
           <snapshots>
               <enabled>true</enabled>
           </snapshots>
       </repository>
       <repository>
           <id>spring-milestones</id>
           <url>http://repo.spring.io/milestone</url>
       </repository>
   </repositories>

三 Mono和Flux返回swagger不能正确识别的问题解决

import io.swagger.models.Operation;
import io.swagger.models.Swagger;
import io.swagger.models.properties.Property;
import io.swagger.models.properties.RefProperty;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;

import java.util.Objects;

/**
 * Classname ReactiveServiceModelToSwagger2MapperAop
 * Description 修复Publisher的泛型变量mapping到swagger
 * @author mafgwo
 * @since 2020/01/08
 */
@Aspect
@Component
public class ReactiveModel2Swagger2MapperConfig {
 
    @Pointcut("execution(* springfox.documentation.swagger2.mappers.ServiceModelToSwagger2MapperImpl.mapDocumentation(..))")
    public void p() {
    }
 
    @Around("p()")
    public Object around(ProceedingJoinPoint pdj) throws Throwable {
        final Object proceed = pdj.proceed();
        if (proceed instanceof Swagger) {
            this.fixRef((Swagger) proceed);
        }
        return proceed;
    }
 
    @SuppressWarnings("deprecation")
    private Swagger fixRef(Swagger swagger) {
        swagger.getPaths().forEach((k, v) -> {
            final Operation get = v.getGet();
            if (Objects.nonNull(get)) {
                get.getResponses().forEach((k2, v2) -> this.fixSchema(v2.getSchema()));
            }
            final Operation post = v.getPost();
            if (Objects.nonNull(post)) {
                post.getResponses().forEach((k2, v2) -> this.fixSchema(v2.getSchema()));
            }
 
            final Operation put = v.getPut();
            if (Objects.nonNull(put))
                put.getResponses().forEach((k2, v2) -> this.fixSchema(v2.getSchema()));
 
            final Operation patch = v.getPatch();
            if (Objects.nonNull(patch))
                patch.getResponses().forEach((k2, v2) -> this.fixSchema(v2.getSchema()));
        });
 
        return swagger;
    }
 
    private void fixSchema(Property schema) {
        if (schema instanceof RefProperty) {
            final RefProperty refProperty = (RefProperty) schema;
            if (refProperty.getSimpleRef().startsWith("Mono«")) {
                final String replaced = refProperty.getSimpleRef()
                        .replaceFirst("Mono«", "")
                        .replaceAll("»$", "");
                refProperty.set$ref("#/definitions/" + replaced);
            } else if (refProperty.getSimpleRef().startsWith("Flux«")) {
                final String replaced = refProperty.getSimpleRef()
                        .replaceFirst("Flux«", "")
                        .replaceAll("»$", "");
                refProperty.set$ref("#/definitions/" + replaced);
            } else {
                refProperty.set$ref(refProperty.get$ref()
                        .replace("definitions/MonoOf", "definitions/")
                        .replace("definitions/FluxOf", "definitions/"));
            }
        }
    }
}

四 通过注解生效swagger

@EnableSwagger2WebFlux