fix: API Catalog swagger link (#2344)

* Add version for gateway api

Signed-off-by: Carson Cook <carson.cook@ibm.com>

* Set unit tests

Signed-off-by: Carson Cook <carson.cook@ibm.com>

* Use api version instead of hardcoded

Signed-off-by: Carson Cook <carson.cook@ibm.com>

Author: CarsonCook

api-catalog-services/src/main/java/org/zowe/apiml/apicatalog/swagger/api/ApiDocV2Service.java

@@ -20,6 +20,7 @@
 import org.springframework.beans.factory.annotation.Value;
 import org.zowe.apiml.apicatalog.services.cached.model.ApiDocInfo;
 import org.zowe.apiml.apicatalog.swagger.ApiDocTransformationException;
+import org.zowe.apiml.config.ApiInfo;
 import org.zowe.apiml.product.gateway.GatewayClient;
 import org.zowe.apiml.product.gateway.GatewayConfigProperties;
 
@@ -47,7 +48,7 @@ public String transformApiDoc(String serviceId, ApiDocInfo apiDocInfo) {
 
         boolean hidden = swagger.getTag(HIDDEN_TAG) != null;
 
-        updateSchemeHostAndLink(swagger, serviceId, hidden);
+        updateSchemeHostAndLink(swagger, serviceId, apiDocInfo.getApiInfo(), hidden);
         updatePaths(swagger, serviceId, apiDocInfo, hidden);
         updateExternalDoc(swagger, apiDocInfo);
 
@@ -66,9 +67,9 @@ public String transformApiDoc(String serviceId, ApiDocInfo apiDocInfo) {
      * @param serviceId the unique service id
      * @param hidden    do not add link for automatically generated API doc
      */
-    private void updateSchemeHostAndLink(Swagger swagger, String serviceId, boolean hidden) {
+    private void updateSchemeHostAndLink(Swagger swagger, String serviceId, ApiInfo apiInfo, boolean hidden) {
         GatewayConfigProperties gatewayConfigProperties = gatewayClient.getGatewayConfigProperties();
-        String swaggerLink = OpenApiUtil.getOpenApiLink(serviceId, gatewayConfigProperties, scheme);
+        String swaggerLink = OpenApiUtil.getOpenApiLink(serviceId, apiInfo, gatewayConfigProperties, scheme);
         log.debug("Updating host for service with id: " + serviceId + " to: " + gatewayConfigProperties.getHostname());
         swagger.setSchemes(Collections.singletonList(Scheme.forValue(scheme)));
         swagger.setHost(gatewayConfigProperties.getHostname());

api-catalog-services/src/main/java/org/zowe/apiml/apicatalog/swagger/api/ApiDocV3Service.java

@@ -28,6 +28,7 @@
 import org.zowe.apiml.apicatalog.services.cached.model.ApiDocInfo;
 import org.zowe.apiml.apicatalog.swagger.ApiDocTransformationException;
 import org.zowe.apiml.apicatalog.swagger.SecuritySchemeSerializer;
+import org.zowe.apiml.config.ApiInfo;
 import org.zowe.apiml.product.gateway.GatewayClient;
 import org.zowe.apiml.product.gateway.GatewayConfigProperties;
 import org.zowe.apiml.product.routing.RoutedService;
@@ -65,7 +66,7 @@ public String transformApiDoc(String serviceId, ApiDocInfo apiDocInfo) {
         boolean hidden = isHidden(openAPI.getTags());
 
         updatePaths(openAPI, serviceId, apiDocInfo, hidden);
-        updateServerAndLink(openAPI, serviceId, hidden);
+        updateServerAndLink(openAPI, serviceId, apiDocInfo.getApiInfo(), hidden);
         updateExternalDoc(openAPI, apiDocInfo);
 
         try {
@@ -76,9 +77,9 @@ public String transformApiDoc(String serviceId, ApiDocInfo apiDocInfo) {
         }
     }
 
-    private void updateServerAndLink(OpenAPI openAPI, String serviceId, boolean hidden) {
+    private void updateServerAndLink(OpenAPI openAPI, String serviceId, ApiInfo apiInfo, boolean hidden) {
         GatewayConfigProperties gatewayConfigProperties = gatewayClient.getGatewayConfigProperties();
-        String swaggerLink = OpenApiUtil.getOpenApiLink(serviceId, gatewayConfigProperties, scheme);
+        String swaggerLink = OpenApiUtil.getOpenApiLink(serviceId, apiInfo, gatewayConfigProperties, scheme);
 
         if (openAPI.getServers() != null) {
             openAPI.getServers()

api-catalog-services/src/main/java/org/zowe/apiml/apicatalog/swagger/api/OpenApiUtil.java

@@ -10,6 +10,7 @@
 package org.zowe.apiml.apicatalog.swagger.api;
 
 import lombok.experimental.UtilityClass;
+import org.zowe.apiml.config.ApiInfo;
 import org.zowe.apiml.product.constants.CoreService;
 import org.zowe.apiml.product.gateway.GatewayConfigProperties;
 
@@ -19,13 +20,16 @@ public class OpenApiUtil {
     private static final String SWAGGER_LOCATION_LINK = "[Swagger/OpenAPI JSON Document]";
     private static final String CATALOG_VERSION = "/api/v1";
     private static final String CATALOG_APIDOC_ENDPOINT = "/apidoc";
-    private static final String HARDCODED_VERSION = "/v1";
     public static final String SEPARATOR = "/";
+    public static final String URL_ENCODED_SPACE = "%20";
 
-    public static String getOpenApiLink(String serviceId, GatewayConfigProperties gatewayConfigProperties, String scheme) {
+    public static String getOpenApiLink(String serviceId, ApiInfo apiInfo, GatewayConfigProperties gatewayConfigProperties, String scheme) {
         String link = scheme + "://" + gatewayConfigProperties.getHostname()
             + SEPARATOR + CoreService.API_CATALOG.getServiceId() + CATALOG_VERSION
-            + CATALOG_APIDOC_ENDPOINT + SEPARATOR + serviceId + HARDCODED_VERSION;
+            + CATALOG_APIDOC_ENDPOINT + SEPARATOR + serviceId;
+        if (apiInfo != null) {
+            link = link + SEPARATOR + apiInfo.getApiId() + URL_ENCODED_SPACE + apiInfo.getVersion();
+        }
         return "\n\n" + SWAGGER_LOCATION_LINK + "(" + link + ")";
     }