Add support for Spring Cloud Function Web. Fixes #1299

bnasslahsen · bnasslahsen · commit e2eda6ae36b6 · 2021-12-24T02:32:30.000+01:00
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/providers/impl/SpringCloudFunctionProvider.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/providers/impl/SpringCloudFunctionProvider.java
@@ -17,13 +17,15 @@
 import io.swagger.v3.oas.models.responses.ApiResponse;
 import io.swagger.v3.oas.models.responses.ApiResponses;
 import org.apache.commons.lang3.ArrayUtils;
+import org.apache.commons.lang3.StringUtils;
 import org.springdoc.core.GenericResponseService;
 import org.springdoc.core.SpringDocAnnotationsUtils;
 import org.springdoc.core.SpringDocConfigProperties;
 import org.springdoc.core.annotations.RouterOperations;
 import org.springdoc.core.fn.RouterOperation;
 import org.springdoc.core.providers.CloudFunctionProvider;
 
+import org.springframework.beans.factory.annotation.Value;
 import org.springframework.cloud.function.context.FunctionCatalog;
 import org.springframework.cloud.function.context.catalog.SimpleFunctionRegistry.FunctionInvocationWrapper;
 import org.springframework.cloud.function.context.config.RoutingFunction;
@@ -83,6 +85,11 @@ public class SpringCloudFunctionProvider implements CloudFunctionProvider {
 	 */
 	private static final String[] defaultMediaTypes = new String[] { MediaType.APPLICATION_JSON_VALUE, MediaType.TEXT_PLAIN_VALUE };
 
+	/**
+	 * The spring cloud function prefix.
+	 */
+	@Value("${spring.cloud.function.web.path:}")
+	private String prefix = "";
 
 	/**
 	 * Instantiates a new Spring cloud function provider.
@@ -95,7 +102,7 @@ public SpringCloudFunctionProvider(Optional<FunctionCatalog> functionCatalogOpti
 		this.functionCatalogOptional = functionCatalogOptional;
 		this.genericResponseService = genericResponseService;
 		this.springDocConfigProperties = springDocConfigProperties;
-		this.applicationContext=applicationContext;
+		this.applicationContext = applicationContext;
 	}
 
 	@Override
@@ -113,10 +120,19 @@ public List<RouterOperation> getRouterOperations(OpenAPI openAPI) {
 									buildRequest(openAPI, name, function, requestMethod, routerOperation);
 									ApiResponses apiResponses = buildResponses(openAPI, function, defaultMediaTypes);
 									routerOperation.getOperationModel().responses(apiResponses);
-									if (GET.equals(requestMethod))
-										routerOperation.setPath(AntPathMatcher.DEFAULT_PATH_SEPARATOR + name + AntPathMatcher.DEFAULT_PATH_SEPARATOR + "{" + name + "}");
-									else
-										routerOperation.setPath(AntPathMatcher.DEFAULT_PATH_SEPARATOR + name);
+									if (StringUtils.isEmpty(prefix)) {
+										if (GET.equals(requestMethod))
+											routerOperation.setPath(AntPathMatcher.DEFAULT_PATH_SEPARATOR + name + AntPathMatcher.DEFAULT_PATH_SEPARATOR + "{" + name + "}");
+										else
+											routerOperation.setPath(AntPathMatcher.DEFAULT_PATH_SEPARATOR + name);
+									}
+									else {
+										if (GET.equals(requestMethod))
+											routerOperation.setPath(prefix + AntPathMatcher.DEFAULT_PATH_SEPARATOR + name + AntPathMatcher.DEFAULT_PATH_SEPARATOR + "{" + name + "}");
+										else
+											routerOperation.setPath(prefix + AntPathMatcher.DEFAULT_PATH_SEPARATOR + name);
+									}
+
 									RouterOperation userRouterOperation = this.getRouterFunctionPaths(name, requestMethod);
 									if (userRouterOperation != null)
 										mergeRouterOperation(routerOperation, userRouterOperation);
@@ -131,7 +147,10 @@ else if (function.isConsumer()) {
 									apiResponse.setContent(new Content());
 									apiResponses.put(String.valueOf(HttpStatus.ACCEPTED.value()), apiResponse.description(HttpStatus.ACCEPTED.getReasonPhrase()));
 									routerOperation.getOperationModel().responses(apiResponses);
-									routerOperation.setPath(AntPathMatcher.DEFAULT_PATH_SEPARATOR + name);
+									if (StringUtils.isEmpty(prefix))
+										routerOperation.setPath(AntPathMatcher.DEFAULT_PATH_SEPARATOR + name);
+									else
+										routerOperation.setPath(prefix + AntPathMatcher.DEFAULT_PATH_SEPARATOR + name);
 									RouterOperation userRouterOperation = this.getRouterFunctionPaths(name, requestMethod);
 									if (userRouterOperation != null)
 										mergeRouterOperation(routerOperation, userRouterOperation);
@@ -142,7 +161,10 @@ else if (function.isSupplier()) {
 									RouterOperation routerOperation = buildRouterOperation(name, " supplier", requestMethod, routerOperationList);
 									ApiResponses apiResponses = buildResponses(openAPI, function, new String[] { springDocConfigProperties.getDefaultProducesMediaType() });
 									routerOperation.getOperationModel().responses(apiResponses);
-									routerOperation.setPath(AntPathMatcher.DEFAULT_PATH_SEPARATOR + name);
+									if (StringUtils.isEmpty(prefix))
+										routerOperation.setPath(AntPathMatcher.DEFAULT_PATH_SEPARATOR + name);
+									else
+										routerOperation.setPath(prefix + AntPathMatcher.DEFAULT_PATH_SEPARATOR + name);
 									RouterOperation userRouterOperation = this.getRouterFunctionPaths(name, requestMethod);
 									if (userRouterOperation != null)
 										mergeRouterOperation(routerOperation, userRouterOperation);
diff --git a/springdoc-openapi-webflux-core/src/test/java/test/org/springdoc/api/app154/SpringDocApp154Test.java b/springdoc-openapi-webflux-core/src/test/java/test/org/springdoc/api/app154/SpringDocApp154Test.java
@@ -29,7 +29,9 @@
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.ComponentScan;
+import org.springframework.test.context.TestPropertySource;
 
+@TestPropertySource(properties = "spring.cloud.function.web.path=/toto")
 public class SpringDocApp154Test extends AbstractSpringDocFunctionTest {
 
 	@SpringBootApplication
diff --git a/springdoc-openapi-webflux-core/src/test/resources/results/app154.json b/springdoc-openapi-webflux-core/src/test/resources/results/app154.json
@@ -11,7 +11,7 @@
     }
   ],
   "paths": {
-    "/lowercase": {
+    "/toto/lowercase": {
       "post": {
         "description": "lowercase function",
         "operationId": "lowercase_POST",
@@ -60,7 +60,7 @@
         }
       }
     },
-    "/lowercase/{lowercase}": {
+    "/toto/lowercase/{lowercase}": {
       "get": {
         "description": "lowercase function",
         "operationId": "lowercase_GET",
@@ -102,7 +102,7 @@
         }
       }
     },
-    "/reverseString": {
+    "/toto/reverseString": {
       "post": {
         "description": "reverseString function",
         "operationId": "reverseString_POST",
@@ -139,7 +139,7 @@
         }
       }
     },
-    "/reverseString/{reverseString}": {
+    "/toto/reverseString/{reverseString}": {
       "get": {
         "description": "reverseString function",
         "operationId": "reverseString_GET",
@@ -172,7 +172,7 @@
         }
       }
     },
-    "/titi": {
+    "/toto/titi": {
       "get": {
         "description": "titi supplier",
         "operationId": "titi_GET",
@@ -190,7 +190,7 @@
         }
       }
     },
-    "/uppercase": {
+    "/toto/uppercase": {
       "post": {
         "description": "uppercase function",
         "operationId": "uppercase_POST",
@@ -227,7 +227,7 @@
         }
       }
     },
-    "/uppercase/{uppercase}": {
+    "/toto/uppercase/{uppercase}": {
       "get": {
         "description": "uppercase function",
         "operationId": "uppercase_GET",
@@ -260,7 +260,7 @@
         }
       }
     },
-    "/words": {
+    "/toto/words": {
       "get": {
         "description": "words supplier",
         "operationId": "words_GET",

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`	`}`
`12`	`12`	`],`
`13`	`13`	`"paths": {`
`14`		`- "/lowercase": {`
	`14`	`+ "/toto/lowercase": {`
`15`	`15`	`"post": {`
`16`	`16`	`"description": "lowercase function",`
`17`	`17`	`"operationId": "lowercase_POST",`
`@@ -60,7 +60,7 @@`
`60`	`60`	`}`
`61`	`61`	`}`
`62`	`62`	`},`
`63`		`- "/lowercase/{lowercase}": {`
	`63`	`+ "/toto/lowercase/{lowercase}": {`
`64`	`64`	`"get": {`
`65`	`65`	`"description": "lowercase function",`
`66`	`66`	`"operationId": "lowercase_GET",`
`@@ -102,7 +102,7 @@`
`102`	`102`	`}`
`103`	`103`	`}`
`104`	`104`	`},`
`105`		`- "/reverseString": {`
	`105`	`+ "/toto/reverseString": {`
`106`	`106`	`"post": {`
`107`	`107`	`"description": "reverseString function",`
`108`	`108`	`"operationId": "reverseString_POST",`
`@@ -139,7 +139,7 @@`
`139`	`139`	`}`
`140`	`140`	`}`
`141`	`141`	`},`
`142`		`- "/reverseString/{reverseString}": {`
	`142`	`+ "/toto/reverseString/{reverseString}": {`
`143`	`143`	`"get": {`
`144`	`144`	`"description": "reverseString function",`
`145`	`145`	`"operationId": "reverseString_GET",`
`@@ -172,7 +172,7 @@`
`172`	`172`	`}`
`173`	`173`	`}`
`174`	`174`	`},`
`175`		`- "/titi": {`
	`175`	`+ "/toto/titi": {`
`176`	`176`	`"get": {`
`177`	`177`	`"description": "titi supplier",`
`178`	`178`	`"operationId": "titi_GET",`
`@@ -190,7 +190,7 @@`
`190`	`190`	`}`
`191`	`191`	`}`
`192`	`192`	`},`
`193`		`- "/uppercase": {`
	`193`	`+ "/toto/uppercase": {`
`194`	`194`	`"post": {`
`195`	`195`	`"description": "uppercase function",`
`196`	`196`	`"operationId": "uppercase_POST",`
`@@ -227,7 +227,7 @@`
`227`	`227`	`}`
`228`	`228`	`}`
`229`	`229`	`},`
`230`		`- "/uppercase/{uppercase}": {`
	`230`	`+ "/toto/uppercase/{uppercase}": {`
`231`	`231`	`"get": {`
`232`	`232`	`"description": "uppercase function",`
`233`	`233`	`"operationId": "uppercase_GET",`
`@@ -260,7 +260,7 @@`
`260`	`260`	`}`
`261`	`261`	`}`
`262`	`262`	`},`
`263`		`- "/words": {`
	`263`	`+ "/toto/words": {`
`264`	`264`	`"get": {`
`265`	`265`	`"description": "words supplier",`
`266`	`266`	`"operationId": "words_GET",`