Append micronaut.server.context-path to endpoints

Fixed #1774
micronaut-projects · Sep 18, 2024 · de22caa · de22caa
1 parent 067fd50
commit de22caa
Show file tree

Hide file tree

Showing 3 changed files with 62 additions and 3 deletions.
diff --git a/openapi/src/main/java/io/micronaut/openapi/visitor/AbstractOpenApiVisitor.java b/openapi/src/main/java/io/micronaut/openapi/visitor/AbstractOpenApiVisitor.java
@@ -124,8 +124,8 @@ Map<String, List<PathItem>> resolvePathItems(VisitorContext context, List<UriMat
         var resultPathItemsMap = new HashMap<String, List<PathItem>>();
 
         for (UriMatchTemplate matchTemplate : matchTemplates) {
-            var segms = parsePathSegments(matchTemplate.toPathString());
-            var finalPaths = buildUrls(segms);
+            var segments = parsePathSegments(matchTemplate.toPathString());
+            var finalPaths = buildUrls(segments, context);
 
             for (String finalPath : finalPaths) {
                 List<PathItem> resultPathItems = resultPathItemsMap.computeIfAbsent(finalPath, k -> new ArrayList<>());

diff --git a/openapi/src/main/java/io/micronaut/openapi/visitor/UrlUtils.java b/openapi/src/main/java/io/micronaut/openapi/visitor/UrlUtils.java
@@ -16,10 +16,13 @@
 package io.micronaut.openapi.visitor;
 
 import io.micronaut.core.annotation.Internal;
+import io.micronaut.core.util.StringUtils;
+import io.micronaut.inject.visitor.VisitorContext;
 
 import java.util.ArrayList;
 import java.util.List;
 
+import static io.micronaut.openapi.visitor.OpenApiConfigProperty.MICRONAUT_SERVER_CONTEXT_PATH;
 import static io.micronaut.openapi.visitor.StringUtil.CLOSE_BRACE;
 import static io.micronaut.openapi.visitor.StringUtil.DOLLAR;
 import static io.micronaut.openapi.visitor.StringUtil.OPEN_BRACE;
@@ -47,7 +50,7 @@ private UrlUtils() {
      * @param segments url template segments
      * @return all possible URL variants by parsed segments.
      */
-    public static List<String> buildUrls(List<Segment> segments) {
+    public static List<String> buildUrls(List<Segment> segments, VisitorContext context) {
 
         var results = new ArrayList<StringBuilder>();
 
@@ -57,6 +60,16 @@ public static List<String> buildUrls(List<Segment> segments) {
             prevSegment = segment;
         }
 
+        String contextPath = ConfigUtils.getConfigProperty(MICRONAUT_SERVER_CONTEXT_PATH, context);
+        if (StringUtils.isNotEmpty(contextPath)) {
+            if (!contextPath.startsWith(SLASH) && !contextPath.startsWith(DOLLAR)) {
+                contextPath = SLASH + contextPath;
+            }
+            if (contextPath.endsWith(SLASH)) {
+                contextPath = contextPath.substring(0, contextPath.length() - 1);
+            }
+        }
+
         var resultStrings = new ArrayList<String>();
         for (var res : results) {
             var url = res.toString();
@@ -67,6 +80,11 @@ public static List<String> buildUrls(List<Segment> segments) {
             } else if (url.startsWith(SLASH + DOLLAR)) {
                 url = url.substring(1);
             }
+
+            if (StringUtils.isNotEmpty(contextPath)) {
+                url = contextPath + url;
+            }
+
             if (!resultStrings.contains(url)) {
                 resultStrings.add(url);
             }

diff --git a/openapi/src/test/groovy/io/micronaut/openapi/visitor/OpenApiControllerVisitorSpec.groovy b/openapi/src/test/groovy/io/micronaut/openapi/visitor/OpenApiControllerVisitorSpec.groovy
@@ -7,7 +7,11 @@ import io.swagger.v3.oas.models.Operation
 import io.swagger.v3.oas.models.PathItem
 import io.swagger.v3.oas.models.Paths
 import io.swagger.v3.oas.models.media.Schema
+import java.nio.file.Path
 import spock.lang.Issue
+import spock.util.environment.RestoreSystemProperties
+
+import static io.micronaut.openapi.visitor.OpenApiConfigProperty.MICRONAUT_OPENAPI_SWAGGER_FILE_GENERATION_ENABLED
 
 class OpenApiControllerVisitorSpec extends AbstractOpenApiTypeElementSpec {
 
@@ -2459,4 +2463,41 @@ class MyBean {}
         operation.requestBody.content."application/json".schema
         operation.requestBody.content."application/json".schema.$ref == "#/components/schemas/SimpleBody"
     }
+
+    @RestoreSystemProperties
+    void "test append micronaut.server.context-path to endpoints"() {
+        given:
+        System.setProperty(OpenApiConfigProperty.MICRONAUT_SERVER_CONTEXT_PATH, "/local-path")
+        System.setProperty(OpenApiConfigProperty.MICRONAUT_OPENAPI_CONTEXT_SERVER_PATH, "/server-context-path")
+
+        buildBeanDefinition('test.MyBean', '''
+package test;
+
+import io.micronaut.http.annotation.Controller;
+import io.micronaut.http.annotation.Get;
+import jakarta.inject.Singleton;
+
+@Controller("/test")
+class TestController {
+
+    @Get("/save{/id}")
+    String save() {
+        return null;
+    }
+}
+
+@Singleton
+class MyBean {}
+''')
+        when:
+        OpenAPI openAPI = Utils.testReference
+        def paths = openAPI.paths
+
+        then:
+        paths
+        paths."/server-context-path/local-path/test/save"
+        paths."/server-context-path/local-path/test/save".get
+        paths."/server-context-path/local-path/test/save/{id}"
+        paths."/server-context-path/local-path/test/save/{id}".get
+    }
 }