Merge pull request #457 from ChinthakaJ98/api-port-fix

Update OpenAPI spec generation flow

Author: ChinthakaJ98

org.eclipse.lemminx/src/main/java/org/eclipse/lemminx/customservice/synapse/api/generator/OpenAPIProcessor.java

@@ -192,7 +192,7 @@ private void updateServersSection(OpenAPI openAPI) {
                 }
             }
         } else {
-            addServersSection(openAPI, SwaggerConstants.DEFAULT_PORT);
+            addServersSection(openAPI, SwaggerConstants.DEFAULT_HTTP_PORT);
         }
     }
 
@@ -209,16 +209,20 @@ private void addServersSection(OpenAPI openAPI, int port) {
         } else {
             basePath = api.getContext();
         }
-        String host;
-        String scheme = SwaggerConstants.PROTOCOL_HTTP;
+        String httpHost, httpsHost;
+        int offset = SwaggerConstants.DEFAULT_HTTP_PORT - port;
         if (StringUtils.isNotBlank(api.getHostname()) && !"-1".equals(api.getPort())) {
-            host = api.getHostname() + ":" + api.getPort();
+            httpHost = api.getHostname() + ":" + port;
+            httpsHost = api.getHostname() + ":" + (SwaggerConstants.DEFAULT_HTTPS_PORT + offset);
         } else {
-            host = SwaggerConstants.DEFAULT_HOST + ":" + port;
+            httpHost = SwaggerConstants.DEFAULT_HOST + ":" + port;
+            httpsHost = SwaggerConstants.DEFAULT_HOST + ":" + (SwaggerConstants.DEFAULT_HTTPS_PORT + offset);
         }
-        Server server = new Server();
-        server.setUrl(scheme + "://" + host + basePath);
-        openAPI.setServers(Arrays.asList(server));
+        Server httpServer = new Server();
+        httpServer.setUrl(SwaggerConstants.PROTOCOL_HTTP + "://" + httpHost + basePath);
+        Server httpsServer = new Server();
+        httpsServer.setUrl(SwaggerConstants.PROTOCOL_HTTPS + "://" + httpsHost + basePath);
+        openAPI.setServers(Arrays.asList(httpServer, httpsServer));
     }
 
     /**
@@ -337,7 +341,7 @@ private void addDefaultRequestBody(Operation operation, Map.Entry methodEntry) {
      * @param isJSONOut       output swagger data type JSON / YAML.
      * @return updated swagger definition as string.
      */
-    public String getUpdatedSwaggerFromApi(String existingSwagger, boolean isJSONIn, boolean isJSONOut)
+    public String getUpdatedSwaggerFromApi(String existingSwagger, boolean isJSONIn, boolean isJSONOut, int port)
             throws APIGenException {
 
         if (api == null) {
@@ -489,7 +493,7 @@ public String getUpdatedSwaggerFromApi(String existingSwagger, boolean isJSONIn,
         // Adding the new path map
         openAPI.setPaths(newPaths);
         updateInfoSection(openAPI);
-        updateServersSection(openAPI);
+        addServersSection(openAPI, port);
 
         try {
             if (isJSONOut) {

org.eclipse.lemminx/src/main/java/org/eclipse/lemminx/customservice/synapse/api/generator/RestApiAdmin.java

@@ -352,7 +352,7 @@ public GenerateSwaggerResponse generateSwaggerFromAPI(GenerateSwaggerParam param
             File existingSwaggerFile = new File(param.swaggerPath);
             if (existingSwaggerFile.exists()) {
                 return generateUpdatedSwaggerFromAPI(existingSwaggerFile, param.isJsonIn, param.isJsonOut,
-                        param.apiPath);
+                        param.apiPath, param.port);
             }
         }
         return generateSwaggerFromSynapseAPIByFormat(param.apiPath, param.isJsonOut, param.port);
@@ -416,7 +416,7 @@ public String generateSwaggerFromSynapseAPIByFormat(API api, boolean isJSON, int
     }
 
     private GenerateSwaggerResponse generateUpdatedSwaggerFromAPI(File existingSwaggerFile, boolean isJSONIn,
-                                                                  boolean isJSONOut, String apiPath) {
+                                                                  boolean isJSONOut, String apiPath, int port) {
 
         GenerateSwaggerResponse response = new GenerateSwaggerResponse();
         API api;
@@ -432,7 +432,7 @@ private GenerateSwaggerResponse generateUpdatedSwaggerFromAPI(File existingSwagg
 
         try {
             String swaggerContent = Utils.readFile(existingSwaggerFile);
-            String generatedSwagger = generateUpdatedSwaggerFromAPI(swaggerContent, isJSONIn, isJSONOut, api);
+            String generatedSwagger = generateUpdatedSwaggerFromAPI(swaggerContent, isJSONIn, isJSONOut, api, port);
             response.setSwagger(generatedSwagger);
         } catch (IOException e) {
             LOGGER.log(Level.SEVERE, "Error occurred while reading the existing Swagger file.", e);
@@ -454,10 +454,10 @@ private GenerateSwaggerResponse generateUpdatedSwaggerFromAPI(File existingSwagg
      * @return OpenApi definition of the updated API.
      * @throws APIGenException Error occurred while generating the updated definition.
      */
-    public String generateUpdatedSwaggerFromAPI(String existingSwagger, boolean isJSONIn, boolean isJSONOut, API api)
+    public String generateUpdatedSwaggerFromAPI(String existingSwagger, boolean isJSONIn, boolean isJSONOut, API api, int port)
             throws APIGenException {
 
         OpenAPIProcessor openAPIProcessor = new OpenAPIProcessor(api);
-        return openAPIProcessor.getUpdatedSwaggerFromApi(existingSwagger, isJSONIn, isJSONOut);
+        return openAPIProcessor.getUpdatedSwaggerFromApi(existingSwagger, isJSONIn, isJSONOut, port);
     }
 }

org.eclipse.lemminx/src/main/java/org/eclipse/lemminx/customservice/synapse/api/generator/SwaggerConstants.java

@@ -178,7 +178,8 @@ public class SwaggerConstants {
     /**
      * Default port for Swagger API
      */
-    public static int DEFAULT_PORT = 8290;
+    public static int DEFAULT_HTTP_PORT = 8290;
+    public static int DEFAULT_HTTPS_PORT = 8253;
 
     /**
      *  Path param regex

org.eclipse.lemminx/src/main/java/org/eclipse/lemminx/customservice/synapse/api/generator/pojo/GenerateSwaggerParam.java

@@ -22,5 +22,5 @@ public class GenerateSwaggerParam {
     public String swaggerPath;
     public boolean isJsonIn;
     public boolean isJsonOut;
-    public int port = SwaggerConstants.DEFAULT_PORT;
+    public int port = SwaggerConstants.DEFAULT_HTTP_PORT;
 }