SpringCloud Gateway与swagger集成解决方案

时间 2020-01-25

标签 springcloud gateway swagger 集成解决方案栏目 CGI 繁體版

原文原文链接

spring cloud gateway 底层采用的是webflux，swagger2暂时不支持webflux，网上的解决方案虽然有一些，好比这篇文章还有《从新定义spring cloud 实战》这本书也有解决方案，书源码连接，
咱们项目里面采用的是集成了最新的swagger3 snapshot版本，须要引入的pom文件有：git

<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-integration</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.integration</groupId>
            <artifactId>spring-integration-webflux</artifactId>
        </dependency>

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>3.0.0-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-spring-webflux</artifactId>
            <version>3.0.0-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-spring-integration-webflux</artifactId>
            <version>3.0.0-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>3.0.0-SNAPSHOT</version>
            <exclusions>
                <exclusion>
                    <groupId>ch.qos.logback</groupId>
                    <artifactId>logback-classic</artifactId>
                </exclusion>
                <exclusion>
                    <groupId>ch.qos.logback</groupId>
                    <artifactId>logback-core</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

                还要引入资源库
                <repositories>
        <repository>
            <id>jcenter-snapshots</id>
            <name>jcenter</name>
            <url>http://oss.jfrog.org/simple/oss-snapshot-local/io/springfox/</url>
            <releases>
               <enabled>false</enabled>
            </releases>
            <snapshots>
               <enabled>true</enabled>
            </snapshots>
        </repository>
    </repositories>

由于公司的构建系统只代理这几个仓库：
http://repo1.maven.org/maven2/
http://jcenter.bintray.com/
http://repo.grails.org/grails/core/github

因此虽然本地能够调试，可是服务器上构建失败，最后结局方案是，把swagger3的jar包引入本地lib文件，而后在pom中引入，解决问题。这是一个细心的活~
pom文件web

<dependency>
            <groupId>classgraph</groupId>
            <artifactId>classgraph</artifactId>
            <version>4.1.7</version>
            <scope>system</scope>
            <systemPath>${basedir}/lib/classgraph-4.1.7.jar</systemPath>
        </dependency>
        <dependency>
            <groupId>classmate</groupId>
            <artifactId>classmate</artifactId>
            <version>1.4.0</version>
            <scope>system</scope>
            <systemPath>${basedir}/lib/classmate-1.4.0.jar</systemPath>
        </dependency>
        <dependency>
            <groupId>mapstruct</groupId>
            <artifactId>mapstruct</artifactId>
            <version>1.2.0.Final</version>
            <scope>system</scope>
            <systemPath>${basedir}/lib/mapstruct-1.2.0.Final.jar</systemPath>
        </dependency>
        <dependency>
            <groupId>rawhttp</groupId>
            <artifactId>rawhttp</artifactId>
            <version>2.0</version>
            <scope>system</scope>
            <systemPath>${basedir}/lib/rawhttp-core-2.0.jar</systemPath>
        </dependency>
        <dependency>
            <groupId>springfox</groupId>
            <artifactId>springfox</artifactId>
            <version>3.0.0-SNAPSHOT</version>
            <scope>system</scope>
            <systemPath>${basedir}/lib/springfox-core-3.0.0-SNAPSHOT.jar</systemPath>
        </dependency>
        <dependency>
            <groupId>springfox</groupId>
            <artifactId>springfox-schema</artifactId>
            <version>3.0.0-SNAPSHOT</version>
            <scope>system</scope>
            <systemPath>${basedir}/lib/springfox-schema-3.0.0-SNAPSHOT.jar</systemPath>
        </dependency>
        <dependency>
            <groupId>springfox</groupId>
            <artifactId>springfox-spi</artifactId>
            <version>3.0.0-SNAPSHOT</version>
            <scope>system</scope>
            <systemPath>${basedir}/lib/springfox-spi-3.0.0-SNAPSHOT.jar</systemPath>
        </dependency>
        <dependency>
            <groupId>springfox</groupId>
            <artifactId>springfox-spring-integration</artifactId>
            <version>3.0.0-SNAPSHOT</version>
            <scope>system</scope>
            <systemPath>${basedir}/lib/springfox-spring-integration-3.0.0-SNAPSHOT.jar</systemPath>
        </dependency>
        <dependency>
            <groupId>springfox</groupId>
            <artifactId>springfox-spring-integration-webflux</artifactId>
            <version>3.0.0-SNAPSHOT</version>
            <scope>system</scope>
            <systemPath>${basedir}/lib/springfox-spring-integration-webflux-3.0.0-SNAPSHOT.jar</systemPath>
        </dependency>
        <dependency>
            <groupId>springfox</groupId>
            <artifactId>springfox-spring-web</artifactId>
            <version>3.0.0-SNAPSHOT</version>
            <scope>system</scope>
            <systemPath>${basedir}/lib/springfox-spring-web-3.0.0-SNAPSHOT.jar</systemPath>
        </dependency>
        <dependency>
            <groupId>springfox</groupId>
            <artifactId>springfox-spring-webflux</artifactId>
            <version>3.0.0-SNAPSHOT</version>
            <scope>system</scope>
            <systemPath>${basedir}/lib/springfox-spring-webflux-3.0.0-SNAPSHOT.jar</systemPath>
        </dependency>
        <dependency>
            <groupId>springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>3.0.0-SNAPSHOT</version>
            <scope>system</scope>
            <systemPath>${basedir}/lib/springfox-swagger2-3.0.0-SNAPSHOT.jar</systemPath>
        </dependency>
        <dependency>
            <groupId>springfox</groupId>
            <artifactId>springfox-swagger-common</artifactId>
            <version>3.0.0-SNAPSHOT</version>
            <scope>system</scope>
            <systemPath>${basedir}/lib/springfox-swagger-common-3.0.0-SNAPSHOT.jar</systemPath>
        </dependency>
        <dependency>
            <groupId>springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>3.0.0-SNAPSHOT</version>
            <scope>system</scope>
            <systemPath>${basedir}/lib/springfox-swagger-ui-3.0.0-SNAPSHOT.jar</systemPath>
        </dependency>
        <dependency>
            <groupId>spring</groupId>
            <artifactId>spring-plugin-core</artifactId>
            <version>1.2.0.RELEASE</version>
            <scope>system</scope>
            <systemPath>${basedir}/lib/spring-plugin-core-1.2.0.RELEASE.jar</systemPath>
        </dependency>
        <dependency>
            <groupId>spring</groupId>
            <artifactId>spring-plugin-metadata</artifactId>
            <version>1.2.0.RELEASE</version>
            <scope>system</scope>
            <systemPath>${basedir}/lib/spring-plugin-metadata-1.2.0.RELEASE.jar</systemPath>
        </dependency>
        <dependency>
            <groupId>swagger</groupId>
            <artifactId>swagger-annotations</artifactId>
            <version>1.5.20</version>
            <scope>system</scope>
            <systemPath>${basedir}/lib/swagger-annotations-1.5.20.jar</systemPath>
        </dependency>
        <dependency>
            <groupId>swagger</groupId>
            <artifactId>swagger-models</artifactId>
            <version>1.5.20</version>
            <scope>system</scope>
            <systemPath>${basedir}/lib/swagger-models-1.5.20.jar</systemPath>
        </dependency>

lib库截图：
spring

springfox提供的快照版本：https://springfox.github.io/springfox/docs/current/#maven
但愿swagger官方尽早提供swagger3的release版本。服务器