- Fix issue #557

Author: rathnapandi

modules/apim-adapter/pom.xml

@@ -103,6 +103,10 @@
             <groupId>org.testng</groupId>
             <artifactId>testng</artifactId>
         </dependency>
+        <dependency>
+            <groupId>io.swagger.parser.v3</groupId>
+            <artifactId>swagger-parser</artifactId>
+        </dependency>
         <dependency>
             <groupId>com.github.axway-api-management-plus.apim-cli</groupId>
             <artifactId>apimcli-tests</artifactId>

modules/apim-adapter/src/main/java/com/axway/apim/api/specification/OAS3xSpecification.java

@@ -3,6 +3,7 @@
 import com.axway.apim.api.API;
 import com.axway.apim.api.specification.filter.JsonNodeOpenAPI3SpecFilter;
 import com.axway.apim.lib.CoreParameters;
+import com.axway.apim.lib.EnvironmentProperties;
 import com.axway.apim.lib.error.AppException;
 import com.axway.apim.lib.error.ErrorCode;
 import com.axway.apim.lib.error.InternalException;
@@ -12,6 +13,9 @@
 import com.fasterxml.jackson.databind.node.ArrayNode;
 import com.fasterxml.jackson.databind.node.ObjectNode;
 import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
+import io.swagger.v3.parser.OpenAPIV3Parser;
+import io.swagger.v3.parser.core.models.ParseOptions;
+import io.swagger.v3.parser.core.models.SwaggerParseResult;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -151,6 +155,9 @@ public boolean parse(byte[] apiSpecificationContent) {
         try {
             this.apiSpecificationContent = apiSpecificationContent;
             setMapperForDataFormat();
+            if(EnvironmentProperties.RESOLVE_OPENAPI_REF){
+                this.apiSpecificationContent = resolveReferences(apiSpecificationContent);
+            }
             if (this.mapper == null) return false;
             openApiNode = this.mapper.readTree(apiSpecificationContent);
             LOG.debug("openapi tag value : {}", openApiNode.get(OPENAPI));
@@ -163,6 +170,15 @@ public boolean parse(byte[] apiSpecificationContent) {
         }
     }
 
+    public byte[] resolveReferences(byte[] apiSpecificationContent) throws JsonProcessingException {
+        OpenAPIV3Parser openAPIV3Parser = new OpenAPIV3Parser();
+        ParseOptions parseOptions = new ParseOptions();
+        parseOptions.setResolve(true); // Enable resolution of $ref references
+        parseOptions.setFlatten(true);
+        SwaggerParseResult swaggerParseResult = openAPIV3Parser.readContents(new String(apiSpecificationContent), null, parseOptions);
+        return mapper.writeValueAsBytes(swaggerParseResult.getOpenAPI());
+    }
+
     @Override
     public boolean equals(Object other) {
         return super.equals(other);

modules/apim-adapter/src/main/java/com/axway/apim/lib/EnvironmentProperties.java

@@ -24,6 +24,7 @@ public class EnvironmentProperties implements Map<String, String> {
     public static final boolean PRINT_CONFIG_CONSOLE = Boolean.parseBoolean(System.getenv().getOrDefault("print_console", FALSE));
     public static final boolean OVERRIDE_CERTIFICATES = Boolean.parseBoolean(System.getenv().getOrDefault("override_certificates", FALSE));
     public static final boolean CHECK_CATALOG = Boolean.parseBoolean(System.getenv().getOrDefault("check_catalog", FALSE));
+    public static final boolean RESOLVE_OPENAPI_REF = Boolean.parseBoolean(System.getenv().getOrDefault("resolve_openapi_ref", FALSE));
     private static final Logger LOG = LoggerFactory.getLogger(EnvironmentProperties.class);
 
     private final String stage;

modules/spectoconfig/src/main/java/com/axway/apim/config/GenerateTemplate.java

@@ -139,6 +139,7 @@ public APIConfig generateTemplate(GenerateTemplateParameters parameters) throws
         List<AuthorizationValue> authorizationValues = new ArrayList<>();
         ParseOptions parseOptions = new ParseOptions();
         parseOptions.setResolve(true); // implicit
+        parseOptions.setFlatten(true);
         String apiDefinition = parameters.getApiDefinition();
         URLParser urlParser = new URLParser(apiDefinition);
         String uri = urlParser.getUri();
@@ -150,7 +151,8 @@ public APIConfig generateTemplate(GenerateTemplateParameters parameters) throws
             AuthorizationValue authorizationValue = new AuthorizationValue(HttpHeaders.AUTHORIZATION, credential, "header");
             authorizationValues.add(authorizationValue);
         }
-        SwaggerParseResult result = new OpenAPIV3Parser().readLocation(uri, authorizationValues, parseOptions);
+        OpenAPIV3Parser parser = new OpenAPIV3Parser();
+        SwaggerParseResult result = parser.readLocation(uri, authorizationValues, parseOptions);
         List<String> messages = result.getMessages();
         if (!messages.isEmpty()) {
             throw new AppException(messages.toString(), ErrorCode.UNSUPPORTED_API_SPECIFICATION);