SpringCloud Gateway與swagger整合解決方案
阿新 • • 發佈：2018-12-12
spring cloud gateway 底層採用的是webflux，swagger2暫時不支援webflux，網上的解決方案雖然有一些，比如這篇文章 還有《重新定義spring cloud 實戰》這本書也有解決方案，書原始碼連結，
我們專案裡面採用的是集成了最新的swagger3 snapshot版本，需要引入的pom檔案有：
<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/
所以雖然本地可以除錯，但是伺服器上構建失敗，最後結局方案是，把swagger3的jar包引入本地lib檔案，然後在pom中引入，解決問題。這是一個細心的活~
pom檔案
<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庫截圖：
springfox提供的快照版本：https://springfox.github.io/springfox/docs/current/#maven
希望swagger官方儘早提供swagger3的release版本。