Merge pull request #66 from xm-online/feature/swgr-v3-meta

Add swagger v3 definition to /swagger-resources

gradle.properties

@@ -1,6 +1,6 @@
 rootProject.name=gate
 profile=dev
-version=2.1.9
+version=2.1.10
 
 # Build properties
 node_version=12.13.0

src/main/java/com/icthh/xm/gate/config/apidoc/GatewaySwaggerResourcesProvider.java

@@ -5,6 +5,11 @@
 
 import io.github.jhipster.config.JHipsterConstants;
 
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.apache.commons.collections.CollectionUtils;
+import org.springframework.cloud.client.ServiceInstance;
+import org.springframework.cloud.client.discovery.DiscoveryClient;
 import org.springframework.cloud.netflix.zuul.filters.Route;
 import org.springframework.cloud.netflix.zuul.filters.RouteLocator;
 import org.springframework.context.annotation.Primary;
@@ -20,35 +25,50 @@
 @Component
 @Primary
 @Profile(JHipsterConstants.SPRING_PROFILE_SWAGGER)
+@RequiredArgsConstructor
+@Slf4j
 public class GatewaySwaggerResourcesProvider implements SwaggerResourcesProvider {
 
+    private final String defaultSwaggerVersion = "2.0";
+    private final String defaultApiDocsPath = "v2/api-docs";
+    private final String SWAGGER_V3 = "v3";
+
     private final RouteLocator routeLocator;
 
-    public GatewaySwaggerResourcesProvider(RouteLocator routeLocator) {
-        this.routeLocator = routeLocator;
-    }
+    private final DiscoveryClient discoveryClient;
+
 
     @Override
     public List<SwaggerResource> get() {
         List<SwaggerResource> resources = new ArrayList<>();
 
         //Add the default swagger resource that correspond to the gateway's own swagger doc
-        resources.add(swaggerResource("default", "/v2/api-docs"));
+        resources.add(swaggerResource("default", defaultApiDocsPath, defaultSwaggerVersion));
 
         //Add the registered microservices swagger docs as additional swagger resources
         List<Route> routes = routeLocator.getRoutes();
         routes.forEach(route -> {
-            resources.add(swaggerResource(route.getId(), route.getFullPath().replace("**", "v2/api-docs")));
+            List<ServiceInstance> instances = discoveryClient.getInstances(route.getId());
+            log.debug("route {} instances.size={}", route.getId(), instances.size());
+            String swaggerVersion = defaultSwaggerVersion;
+            String apiDocsPath = defaultApiDocsPath;
+            if (CollectionUtils.isNotEmpty(instances)) {
+                if (SWAGGER_V3.equalsIgnoreCase(instances.get(0).getMetadata().get("swagger"))) {
+                    swaggerVersion = "3.0";
+                    apiDocsPath = "v3/api-docs";
+                }
+            }
+            resources.add(swaggerResource(route.getId(), route.getFullPath().replace("**", apiDocsPath), swaggerVersion));
         });
 
         return resources;
     }
 
-    private SwaggerResource swaggerResource(String name, String location) {
+    private SwaggerResource swaggerResource(String name, String location, String swaggerVersion) {
         SwaggerResource swaggerResource = new SwaggerResource();
         swaggerResource.setName(name);
         swaggerResource.setLocation(location);
-        swaggerResource.setSwaggerVersion("2.0");
+        swaggerResource.setSwaggerVersion(swaggerVersion);
         return swaggerResource;
     }
 }