feat: Re-integrate Swagger with SpringDoc (#380)

higress-group · Dec 12, 2024 · 5e6f891 · 5e6f891
1 parent 9aa49b1
commit 5e6f891
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 48 deletions.
diff --git a/backend/console/pom.xml b/backend/console/pom.xml
@@ -37,26 +37,8 @@
 			<artifactId>spring-boot-starter-validation</artifactId>
 		</dependency>
 		<dependency>
-			<groupId>io.springfox</groupId>
-			<artifactId>springfox-boot-starter</artifactId>
-			<exclusions>
-				<exclusion>
-					<artifactId>swagger-models</artifactId>
-					<groupId>io.swagger.core.v3</groupId>
-				</exclusion>
-				<exclusion>
-					<artifactId>swagger-annotations</artifactId>
-					<groupId>io.swagger</groupId>
-				</exclusion>
-				<exclusion>
-					<artifactId>swagger-annotations</artifactId>
-					<groupId>io.swagger.core.v3</groupId>
-				</exclusion>
-				<exclusion>
-					<artifactId>swagger-models</artifactId>
-					<groupId>io.swagger</groupId>
-				</exclusion>
-			</exclusions>
+			<groupId>org.springdoc</groupId>
+			<artifactId>springdoc-openapi-ui</artifactId>
 		</dependency>
 
 		<dependency>

diff --git a/backend/console/src/main/java/com/alibaba/higress/console/config/SwaggerConfig.java b/backend/console/src/main/java/com/alibaba/higress/console/config/SwaggerConfig.java
@@ -12,31 +12,27 @@
  */
 package com.alibaba.higress.console.config;
 
+import org.springdoc.core.GroupedOpenApi;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 
-import springfox.documentation.builders.ApiInfoBuilder;
-import springfox.documentation.builders.PathSelectors;
-import springfox.documentation.builders.RequestHandlerSelectors;
-import springfox.documentation.oas.annotations.EnableOpenApi;
-import springfox.documentation.service.ApiInfo;
-import springfox.documentation.service.Contact;
-import springfox.documentation.spi.DocumentationType;
-import springfox.documentation.spring.web.plugins.Docket;
+import io.swagger.v3.oas.models.info.Contact;
+import io.swagger.v3.oas.models.info.Info;
+import io.swagger.v3.oas.models.info.License;
 
 @Configuration
-@EnableOpenApi
 public class SwaggerConfig {
 
     @Bean
-    public Docket docket() {
-        ApiInfo apiInfo = new ApiInfoBuilder().title("Higress Console")
-            .contact(new Contact("CH3CHO", "https://github.com/higress-group/higress-console", "[email protected]"))
+    public GroupedOpenApi openApi() {
+        Info apiInfo = new Info().title("Higress Console")
+            .contact(new Contact().name("CH3CHO").url("https://github.com/higress-group/higress-console")
+                .email("[email protected]"))
             .description(
                 "Higress is a next-generation cloud-native gateway based on Alibaba's internal gateway practices.")
-            .license("Apache 2.0").licenseUrl("http://www.apache.org/licenses/LICENSE-2.0").build();
-        return new Docket(DocumentationType.OAS_30).apiInfo(apiInfo).enable(true).select()
-            .apis(RequestHandlerSelectors.basePackage("com.alibaba.higress.console.controller"))
-            .paths(PathSelectors.any()).build().pathMapping("/");
+            .license(new License().name("Apache 2.0").url("http://www.apache.org/licenses/LICENSE-2.0"));
+        return GroupedOpenApi.builder().group("Higress").displayName("Higress Console")
+            .addOpenApiCustomiser(openApi -> openApi.info(apiInfo))
+            .packagesToScan("com.alibaba.higress.console.controller").build();
     }
 }
diff --git a/backend/pom.xml b/backend/pom.xml
@@ -52,7 +52,6 @@
 	<properties>
 		<java.version>17</java.version>
 
-		<springfox.version>3.0.0</springfox.version>
 		<retrofit.version>2.9.0</retrofit.version>
 		<guava.version>31.1-jre</guava.version>
 		<commons-lang3.version>3.13.0</commons-lang3.version>
@@ -61,7 +60,6 @@
 		<!-- https://github.com/kubernetes-client/java/wiki/2.-Versioning-and-Compatibility -->
 		<k8s-client.version>17.0.0</k8s-client.version>
 		<bouncycastle.version>1.46</bouncycastle.version>
-		<swagger-parser.version>2.1.21</swagger-parser.version>
 
 		<pmd-plugin.version>3.20.0</pmd-plugin.version>
 		<frontend-plugin.version>1.12.1</frontend-plugin.version>
@@ -71,6 +69,8 @@
 		<maven-gpg-plugin.version>3.1.0</maven-gpg-plugin.version>
 		<central-publishing-maven-plugin.version>0.3.0</central-publishing-maven-plugin.version>
 		<lombok-maven-plugin.version>1.18.20.0</lombok-maven-plugin.version>
+		<swagger-core.version>2.2.20</swagger-core.version>
+		<springdoc.version>1.8.0</springdoc.version>
 
 		<plugin.inputEncoding>${project.build.sourceEncoding}</plugin.inputEncoding>
 		<plugin.outputEncoding>${project.build.sourceEncoding}</plugin.outputEncoding>
@@ -83,11 +83,6 @@
 
 	<dependencyManagement>
 		<dependencies>
-			<dependency>
-				<groupId>io.springfox</groupId>
-				<artifactId>springfox-boot-starter</artifactId>
-				<version>${springfox.version}</version>
-			</dependency>
 			<dependency>
 				<groupId>com.google.guava</groupId>
 				<artifactId>guava</artifactId>
@@ -129,9 +124,14 @@
 				<version>${retrofit.version}</version>
 			</dependency>
 			<dependency>
-				<groupId>io.swagger.parser.v3</groupId>
-				<artifactId>swagger-parser</artifactId>
-				<version>${swagger-parser.version}</version>
+				<groupId>org.springdoc</groupId>
+				<artifactId>springdoc-openapi-ui</artifactId>
+				<version>${springdoc.version}</version>
+			</dependency>
+			<dependency>
+				<groupId>io.swagger.core.v3</groupId>
+				<artifactId>swagger-core</artifactId>
+				<version>${swagger-core.version}</version>
 			</dependency>
 		</dependencies>
 	</dependencyManagement>

diff --git a/backend/sdk/pom.xml b/backend/sdk/pom.xml
@@ -29,8 +29,8 @@
 		</dependency>
 
 		<dependency>
-			<groupId>io.swagger.parser.v3</groupId>
-			<artifactId>swagger-parser</artifactId>
+			<groupId>io.swagger.core.v3</groupId>
+			<artifactId>swagger-core</artifactId>
 		</dependency>
 		<dependency>
 			<groupId>com.alibaba</groupId>