fix:fix swagger not working bug. (#1225)

Tencent · Jan 20, 2024 · 38792c1 · 38792c1
1 parent dd56d3c
commit 38792c1
Show file tree

Hide file tree

Showing 21 changed files with 233 additions and 499 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -21,3 +21,4 @@
 - [feat: support nacos namespace mapping](https://github.com/Tencent/spring-cloud-tencent/pull/1192)
 - [fix:fix rule-based router when using RestTemplate.](https://github.com/Tencent/spring-cloud-tencent/pull/1201)
 - [fix:fix sct-all wrong spring boot version obtain.](https://github.com/Tencent/spring-cloud-tencent/pull/1205)
+- [fix:fix swagger not working bug.](https://github.com/Tencent/spring-cloud-tencent/pull/1125)
diff --git a/...ris-config/src/test/java/com/tencent/cloud/polaris/config/adapter/MockedConfigKVFile.java b/...ris-config/src/test/java/com/tencent/cloud/polaris/config/adapter/MockedConfigKVFile.java
@@ -138,6 +138,11 @@ public boolean hasContent() {
 		return false;
 	}
 
+	@Override
+	public String getMd5() {
+		return null;
+	}
+
 	@Override
 	public void addChangeListener(ConfigFileChangeListener configFileChangeListener) {
 

diff --git a/.../java/com/tencent/cloud/polaris/config/condition/ConditionalOnReflectRefreshTypeTest.java b/.../java/com/tencent/cloud/polaris/config/condition/ConditionalOnReflectRefreshTypeTest.java
@@ -20,6 +20,7 @@
 
 import java.io.IOException;
 import java.net.ServerSocket;
+import java.util.Objects;
 
 import com.tencent.cloud.polaris.config.PolarisConfigAutoConfiguration;
 import com.tencent.cloud.polaris.config.PolarisConfigBootstrapAutoConfiguration;
@@ -67,7 +68,9 @@ static void beforeAll() {
 
 	@AfterAll
 	static void afterAll() throws IOException {
-		serverSocket.close();
+		if (Objects.nonNull(serverSocket)) {
+			serverSocket.close();
+		}
 	}
 
 	@Test

diff --git a/...est/java/com/tencent/cloud/polaris/config/spring/annotation/SpringValueProcessorTest.java b/...est/java/com/tencent/cloud/polaris/config/spring/annotation/SpringValueProcessorTest.java
@@ -22,6 +22,7 @@
 import java.lang.reflect.Method;
 import java.net.ServerSocket;
 import java.util.Collection;
+import java.util.Objects;
 import java.util.Optional;
 
 import com.tencent.cloud.polaris.config.PolarisConfigBootstrapAutoConfiguration;
@@ -71,7 +72,9 @@ static void beforeAll() {
 
 	@AfterAll
 	static void afterAll() throws IOException {
-		serverSocket.close();
+		if (Objects.nonNull(serverSocket)) {
+			serverSocket.close();
+		}
 	}
 
 	@Test

diff --git a/spring-cloud-starter-tencent-polaris-contract/pom.xml b/spring-cloud-starter-tencent-polaris-contract/pom.xml
@@ -36,28 +36,13 @@
 		<!-- Spring cloud dependencies start -->
 
 		<dependency>
-			<groupId>io.springfox</groupId>
-			<artifactId>springfox-boot-starter</artifactId>
-			<exclusions>
-				<exclusion>
-					<artifactId>swagger-models</artifactId>
-					<groupId>io.swagger</groupId>
-				</exclusion>
-				<exclusion>
-					<artifactId>swagger-annotations</artifactId>
-					<groupId>io.swagger</groupId>
-				</exclusion>
-			</exclusions>
+			<groupId>org.springdoc</groupId>
+			<artifactId>springdoc-openapi-ui</artifactId>
 		</dependency>
 
 		<dependency>
-			<groupId>io.swagger</groupId>
-			<artifactId>swagger-models</artifactId>
-		</dependency>
-
-		<dependency>
-			<groupId>io.swagger</groupId>
-			<artifactId>swagger-annotations</artifactId>
+			<groupId>org.springdoc</groupId>
+			<artifactId>springdoc-openapi-webflux-ui</artifactId>
 		</dependency>
 
 		<dependency>

diff --git a/...is-contract/src/main/java/com/tencent/cloud/polaris/contract/PolarisContractReporter.java b/...is-contract/src/main/java/com/tencent/cloud/polaris/contract/PolarisContractReporter.java
@@ -29,15 +29,16 @@
 import com.tencent.polaris.api.plugin.server.InterfaceDescriptor;
 import com.tencent.polaris.api.plugin.server.ReportServiceContractRequest;
 import com.tencent.polaris.api.plugin.server.ReportServiceContractResponse;
-import io.swagger.models.HttpMethod;
-import io.swagger.models.Operation;
-import io.swagger.models.Path;
-import io.swagger.models.Swagger;
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.Operation;
+import io.swagger.v3.oas.models.PathItem;
+import io.swagger.v3.oas.models.Paths;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import springfox.documentation.service.Documentation;
-import springfox.documentation.spring.web.DocumentationCache;
-import springfox.documentation.swagger2.mappers.ServiceModelToSwagger2Mapper;
+import org.springdoc.api.AbstractOpenApiResource;
+import org.springdoc.api.AbstractOpenApiResourceUtil;
+import org.springdoc.webflux.api.OpenApiWebFluxUtil;
+import org.springdoc.webmvc.api.OpenApiWebMvcUtil;
 
 import org.springframework.boot.context.event.ApplicationReadyEvent;
 import org.springframework.context.ApplicationListener;
@@ -52,18 +53,21 @@
 public class PolarisContractReporter implements ApplicationListener<ApplicationReadyEvent> {
 
 	private final Logger LOG = LoggerFactory.getLogger(PolarisContractReporter.class);
-	private final ServiceModelToSwagger2Mapper swagger2Mapper;
-	private final DocumentationCache documentationCache;
+
+	private final org.springdoc.webmvc.api.MultipleOpenApiResource multipleOpenApiWebMvcResource;
+	private final org.springdoc.webflux.api.MultipleOpenApiResource multipleOpenApiWebFluxResource;
 	private final PolarisContractProperties polarisContractProperties;
 
 	private final ProviderAPI providerAPI;
 
 	private final PolarisDiscoveryProperties polarisDiscoveryProperties;
 
-	public PolarisContractReporter(DocumentationCache documentationCache, ServiceModelToSwagger2Mapper swagger2Mapper,
-			PolarisContractProperties polarisContractProperties, ProviderAPI providerAPI, PolarisDiscoveryProperties polarisDiscoveryProperties) {
-		this.swagger2Mapper = swagger2Mapper;
-		this.documentationCache = documentationCache;
+	public PolarisContractReporter(org.springdoc.webmvc.api.MultipleOpenApiResource multipleOpenApiWebMvcResource,
+			org.springdoc.webflux.api.MultipleOpenApiResource multipleOpenApiWebFluxResource,
+			PolarisContractProperties polarisContractProperties, ProviderAPI providerAPI,
+			PolarisDiscoveryProperties polarisDiscoveryProperties) {
+		this.multipleOpenApiWebMvcResource = multipleOpenApiWebMvcResource;
+		this.multipleOpenApiWebFluxResource = multipleOpenApiWebFluxResource;
 		this.polarisContractProperties = polarisContractProperties;
 		this.providerAPI = providerAPI;
 		this.polarisDiscoveryProperties = polarisDiscoveryProperties;
@@ -73,29 +77,37 @@ public PolarisContractReporter(DocumentationCache documentationCache, ServiceMod
 	public void onApplicationEvent(@NonNull ApplicationReadyEvent applicationReadyEvent) {
 		if (polarisContractProperties.isReportEnabled()) {
 			try {
-				Documentation documentation = documentationCache.documentationByGroup(polarisContractProperties.getGroup());
-				Swagger swagger = swagger2Mapper.mapDocumentation(documentation);
-				if (swagger != null) {
+				AbstractOpenApiResource openApiResource = null;
+				if (multipleOpenApiWebMvcResource != null) {
+					openApiResource = OpenApiWebMvcUtil.getOpenApiResourceOrThrow(multipleOpenApiWebMvcResource, polarisContractProperties.getGroup());
+				}
+				else if (multipleOpenApiWebFluxResource != null) {
+					openApiResource = OpenApiWebFluxUtil.getOpenApiResourceOrThrow(multipleOpenApiWebFluxResource, polarisContractProperties.getGroup());
+				}
+				OpenAPI openAPI = null;
+				if (openApiResource != null) {
+					openAPI = AbstractOpenApiResourceUtil.getOpenApi(openApiResource);
+				}
+				if (openAPI != null) {
 					ReportServiceContractRequest request = new ReportServiceContractRequest();
 					request.setName(polarisDiscoveryProperties.getService());
 					request.setNamespace(polarisDiscoveryProperties.getNamespace());
 					request.setService(polarisDiscoveryProperties.getService());
 					request.setProtocol("http");
 					request.setVersion(polarisDiscoveryProperties.getVersion());
-					List<InterfaceDescriptor> interfaceDescriptorList = getInterfaceDescriptorFromSwagger(swagger);
+					List<InterfaceDescriptor> interfaceDescriptorList = getInterfaceDescriptorFromSwagger(openAPI);
 					request.setInterfaceDescriptors(interfaceDescriptorList);
 					ReportServiceContractResponse response = providerAPI.reportServiceContract(request);
 					LOG.info("Service contract [Namespace: {}. Name: {}. Service: {}. Protocol:{}. Version: {}. API counter: {}] is reported.",
 							request.getNamespace(), request.getName(), request.getService(), request.getProtocol(),
 							request.getVersion(), request.getInterfaceDescriptors().size());
 					if (LOG.isDebugEnabled()) {
-						String jsonValue = JacksonUtils.serialize2Json(swagger);
+						String jsonValue = JacksonUtils.serialize2Json(openAPI);
 						LOG.debug("OpenApi json data: {}", jsonValue);
 					}
 				}
 				else {
-					LOG.warn("Swagger or json is null, documentationCache keys:{}, group:{}", documentationCache.all()
-							.keySet(), polarisContractProperties.getGroup());
+					LOG.warn("OpenAPI or json is null, group:{}", polarisContractProperties.getGroup());
 				}
 			}
 			catch (Throwable t) {
@@ -104,11 +116,11 @@ public void onApplicationEvent(@NonNull ApplicationReadyEvent applicationReadyEv
 		}
 	}
 
-	private List<InterfaceDescriptor> getInterfaceDescriptorFromSwagger(Swagger swagger) {
+	private List<InterfaceDescriptor> getInterfaceDescriptorFromSwagger(OpenAPI openAPI) {
 		List<InterfaceDescriptor> interfaceDescriptorList = new ArrayList<>();
-		Map<String, Path> paths = swagger.getPaths();
-		for (Map.Entry<String, Path> p : paths.entrySet()) {
-			Path path = p.getValue();
+		Paths paths = openAPI.getPaths();
+		for (Map.Entry<String, PathItem> p : paths.entrySet()) {
+			PathItem path = p.getValue();
 			Map<String, Operation> operationMap = getOperationMapFromPath(path);
 			if (CollectionUtils.isEmpty(operationMap)) {
 				continue;
@@ -124,29 +136,29 @@ private List<InterfaceDescriptor> getInterfaceDescriptorFromSwagger(Swagger swag
 		return interfaceDescriptorList;
 	}
 
-	private Map<String, Operation> getOperationMapFromPath(Path path) {
+	private Map<String, Operation> getOperationMapFromPath(PathItem path) {
 		Map<String, Operation> operationMap = new HashMap<>();
 
 		if (path.getGet() != null) {
-			operationMap.put(HttpMethod.GET.name(), path.getGet());
+			operationMap.put(PathItem.HttpMethod.GET.name(), path.getGet());
 		}
 		if (path.getPut() != null) {
-			operationMap.put(HttpMethod.PUT.name(), path.getPut());
+			operationMap.put(PathItem.HttpMethod.PUT.name(), path.getPut());
 		}
 		if (path.getPost() != null) {
-			operationMap.put(HttpMethod.POST.name(), path.getPost());
+			operationMap.put(PathItem.HttpMethod.POST.name(), path.getPost());
 		}
 		if (path.getHead() != null) {
-			operationMap.put(HttpMethod.HEAD.name(), path.getHead());
+			operationMap.put(PathItem.HttpMethod.HEAD.name(), path.getHead());
 		}
 		if (path.getDelete() != null) {
-			operationMap.put(HttpMethod.DELETE.name(), path.getDelete());
+			operationMap.put(PathItem.HttpMethod.DELETE.name(), path.getDelete());
 		}
 		if (path.getPatch() != null) {
-			operationMap.put(HttpMethod.PATCH.name(), path.getPatch());
+			operationMap.put(PathItem.HttpMethod.PATCH.name(), path.getPatch());
 		}
 		if (path.getOptions() != null) {
-			operationMap.put(HttpMethod.OPTIONS.name(), path.getOptions());
+			operationMap.put(PathItem.HttpMethod.OPTIONS.name(), path.getOptions());
 		}
 
 		return operationMap;

diff --git a/...com/tencent/cloud/polaris/contract/config/PolarisContractPropertiesAutoConfiguration.java b/...com/tencent/cloud/polaris/contract/config/PolarisContractPropertiesAutoConfiguration.java
@@ -17,13 +17,12 @@
 
 package com.tencent.cloud.polaris.contract.config;
 
-import javax.annotation.Nullable;
-
 import com.tencent.cloud.polaris.context.ConditionalOnPolarisEnabled;
 
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.lang.Nullable;
 
 /**
  * Auto configuration for Polaris contract properties.