Improve support of Webflux with Functional Endpoints

bnasslahsen · bnasslahsen · commit ee8c964b44a3 · 2020-05-04T01:58:44.000+02:00
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/api/AbstractOpenApiResource.java b/springdoc-openapi-common/src/main/java/org/springdoc/api/AbstractOpenApiResource.java
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/AbstractRequestBuilder.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/AbstractRequestBuilder.java
@@ -25,6 +25,7 @@
 import java.math.BigDecimal;
 import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.Collection;
 import java.util.HashMap;
 import java.util.LinkedHashMap;
 import java.util.List;
@@ -230,6 +231,11 @@ private LinkedHashMap<String, Parameter> getParameterLinkedHashMap(Components co
 			}
 		}
 
+		getHeaders(methodAttributes, map);
+		return map;
+	}
+
+	public static Collection<Parameter> getHeaders(MethodAttributes methodAttributes, LinkedHashMap<String, Parameter> map) {
 		for (Map.Entry<String, String> entry : methodAttributes.getHeaders().entrySet()) {
 			Parameter parameter = new Parameter().in(ParameterIn.HEADER.toString()).name(entry.getKey()).schema(new StringSchema().addEnumItem(entry.getValue()));
 			if (map.containsKey(entry.getKey())) {
@@ -239,7 +245,7 @@ private LinkedHashMap<String, Parameter> getParameterLinkedHashMap(Components co
 			}
 			map.put(entry.getKey(), parameter);
 		}
-		return map;
+		return map.values();
 	}
 
 	protected Parameter customiseParameter(Parameter parameter, ParameterInfo parameterInfo) {
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/GenericParameterBuilder.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/GenericParameterBuilder.java
@@ -93,7 +93,7 @@ public static boolean isFile(Class type) {
 		return FILE_TYPES.stream().anyMatch(clazz -> clazz.isAssignableFrom(type));
 	}
 
-	Parameter mergeParameter(List<Parameter> existingParamDoc, Parameter paramCalcul) {
+	public static Parameter mergeParameter(List<Parameter> existingParamDoc, Parameter paramCalcul) {
 		Parameter result = paramCalcul;
 		if (paramCalcul != null && paramCalcul.getName() != null) {
 			final String name = paramCalcul.getName();
@@ -108,7 +108,7 @@ Parameter mergeParameter(List<Parameter> existingParamDoc, Parameter paramCalcul
 		return result;
 	}
 
-	private void mergeParameter(Parameter paramCalcul, Parameter paramDoc) {
+	private static void mergeParameter(Parameter paramCalcul, Parameter paramDoc) {
 		if (StringUtils.isBlank(paramDoc.getDescription()))
 			paramDoc.setDescription(paramCalcul.getDescription());
 
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/models/RouterFunctionData.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/models/RouterFunctionData.java
@@ -21,7 +21,9 @@
 package org.springdoc.core.models;
 
 import java.util.ArrayList;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 import java.util.Set;
 
 import org.apache.commons.lang3.ArrayUtils;
@@ -41,7 +43,7 @@ public class RouterFunctionData {
 
 	private List<String> headers = new ArrayList<>();
 
-	private String queryParam;
+	private Map<String, String> queryParams = new HashMap<>();
 
 	private RequestMethod[] methods;
 
@@ -53,12 +55,12 @@ public void setPath(String path) {
 		this.path = path;
 	}
 
-	public String getQueryParam() {
-		return queryParam;
+	public Map<String, String> getQueryParams() {
+		return queryParams;
 	}
 
-	public void setQueryParam(String queryParam) {
-		this.queryParam = queryParam;
+	public void addQueryParams(String name, String value) {
+		this.queryParams.put(name, value);
 	}
 
 	public String[] getHeaders() {
@@ -89,7 +91,7 @@ public void addConsumes(String consumes) {
 
 	public void addProduces(String produces) {
 		if (StringUtils.isNotBlank(produces))
-			 this.produces.add(produces);
+			this.produces.add(produces);
 	}
 
 	private RequestMethod[] getMethod(Set<HttpMethod> methods) {
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/models/RouterOperation.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/models/RouterOperation.java
@@ -20,6 +20,8 @@
 
 package org.springdoc.core.models;
 
+import java.util.Map;
+
 import io.swagger.v3.oas.annotations.Operation;
 import org.apache.commons.lang3.ArrayUtils;
 import org.apache.commons.lang3.StringUtils;
@@ -45,6 +47,8 @@ public class RouterOperation {
 
 	private Class<?>[] parameterTypes;
 
+	private Map<String, String> queryParams;
+
 	private Operation operation;
 
 	public RouterOperation(org.springdoc.core.annotations.RouterOperation routerOperationAnnotation) {
@@ -69,7 +73,12 @@ public RouterOperation(org.springdoc.core.annotations.RouterOperation routerOper
 		this.parameterTypes = routerOperationAnnotation.parameterTypes();
 		this.operation = routerOperationAnnotation.operation();
 		this.headers = ArrayUtils.isEmpty(routerOperationAnnotation.headers()) ? routerFunctionData.getHeaders() : routerOperationAnnotation.headers();
+		this.queryParams = routerFunctionData.getQueryParams();
+	}
 
+	public RouterOperation(String path, RequestMethod[] methods) {
+		this.path = path;
+		this.methods = methods;
 	}
 
 	public String getPath() {
@@ -143,4 +152,12 @@ public String[] getHeaders() {
 	public void setHeaders(String[] headers) {
 		this.headers = headers;
 	}
+
+	public Map<String, String> getQueryParams() {
+		return queryParams;
+	}
+
+	public void setQueryParams(Map<String, String> queryParams) {
+		this.queryParams = queryParams;
+	}
 }
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/visitor/AbstractRouterFunctionVisitor.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/visitor/AbstractRouterFunctionVisitor.java
@@ -57,7 +57,7 @@ public List<RouterFunctionData> getRouterFunctionDatas() {
 	}
 
 	public void queryParam(String name, String value) {
-		// Not yet needed
+		routerFunctionData.addQueryParams(name, value);
 	}
 
 	public void pathExtension(String extension) {
@@ -100,7 +100,4 @@ public void endNegate() {
 		// Not yet needed
 	}
 
-
-
-
 }
diff --git a/springdoc-openapi-webflux-core/src/test/java/test/org/springdoc/api/app75/PostRouter.java b/springdoc-openapi-webflux-core/src/test/java/test/org/springdoc/api/app75/PostRouter.java
@@ -40,12 +40,14 @@
 import static org.springframework.web.reactive.function.server.RequestPredicates.GET;
 import static org.springframework.web.reactive.function.server.RequestPredicates.POST;
 import static org.springframework.web.reactive.function.server.RequestPredicates.PUT;
+import static org.springframework.web.reactive.function.server.RequestPredicates.queryParam;
 import static org.springframework.web.reactive.function.server.RouterFunctions.route;
 
 @Configuration
 class PostRouter {
 
-	@RouterOperations({ @RouterOperation(path = "/posts", method = RequestMethod.GET, operation = @Operation(operationId = "all",
+	@RouterOperations({ @RouterOperation(path = "/posts", method = RequestMethod.GET, headers = {"x-header1=test1","x-header2=test2"}, operation = @Operation(operationId = "all",
+			parameters = { @Parameter(name = "key", description = "sample description"),@Parameter(name = "test", description = "sample desc")},
 			responses = @ApiResponse(responseCode = "200", content = @Content(array = @ArraySchema(schema = @Schema(implementation = Post.class)))))),
 			@RouterOperation(path = "/posts", method = RequestMethod.POST, operation = @Operation(operationId = "create",
 					requestBody = @RequestBody(content = @Content(schema = @Schema(implementation = Post.class))), responses = @ApiResponse(responseCode = "201"))),
@@ -57,7 +59,7 @@ class PostRouter {
 					responses = @ApiResponse(responseCode = "202", content = @Content(schema = @Schema(implementation = Post.class))))) })
 	@Bean
 	public RouterFunction<ServerResponse> routes(PostHandler postController) {
-		return route(GET("/posts"), postController::all)
+		return route(GET("/posts").and(queryParam("key", "value")), postController::all)
 				.andRoute(POST("/posts"), postController::create)
 				.andRoute(GET("/posts/{id}"), postController::get)
 				.andRoute(PUT("/posts/{id}"), postController::update);
diff --git a/springdoc-openapi-webflux-core/src/test/resources/results/app75.json b/springdoc-openapi-webflux-core/src/test/resources/results/app75.json
@@ -14,6 +14,46 @@
     "/posts": {
       "get": {
         "operationId": "all",
+        "parameters": [
+          {
+            "name": "key",
+            "in": "query",
+            "description": "sample description",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "default": "value"
+            }
+          },
+          {
+            "name": "test",
+            "in": "query",
+            "description": "sample desc",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "x-header1",
+            "in": "header",
+            "schema": {
+              "type": "string",
+              "enum": [
+                "test1"
+              ]
+            }
+          },
+          {
+            "name": "x-header2",
+            "in": "header",
+            "schema": {
+              "type": "string",
+              "enum": [
+                "test2"
+              ]
+            }
+          }
+        ],
         "responses": {
           "200": {
             "description": "OK",

Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,7 @@`
`25`	`25`	`import java.math.BigDecimal;`
`26`	`26`	`import java.util.ArrayList;`
`27`	`27`	`import java.util.Arrays;`
	`28`	`+import java.util.Collection;`
`28`	`29`	`import java.util.HashMap;`
`29`	`30`	`import java.util.LinkedHashMap;`
`30`	`31`	`import java.util.List;`
`@@ -230,6 +231,11 @@ private LinkedHashMap<String, Parameter> getParameterLinkedHashMap(Components co`
`230`	`231`	`}`
`231`	`232`	`}`
`232`	`233`
	`234`	`+ getHeaders(methodAttributes, map);`
	`235`	`+ return map;`
	`236`	`+ }`
	`237`	`+`
	`238`	`+ public static Collection<Parameter> getHeaders(MethodAttributes methodAttributes, LinkedHashMap<String, Parameter> map) {`
`233`	`239`	`for (Map.Entry<String, String> entry : methodAttributes.getHeaders().entrySet()) {`
`234`	`240`	`Parameter parameter = new Parameter().in(ParameterIn.HEADER.toString()).name(entry.getKey()).schema(new StringSchema().addEnumItem(entry.getValue()));`
`235`	`241`	`if (map.containsKey(entry.getKey())) {`
`@@ -239,7 +245,7 @@ private LinkedHashMap<String, Parameter> getParameterLinkedHashMap(Components co`
`239`	`245`	`}`
`240`	`246`	`map.put(entry.getKey(), parameter);`
`241`	`247`	`}`
`242`		`- return map;`
	`248`	`+ return map.values();`
`243`	`249`	`}`
`244`	`250`
`245`	`251`	`protected Parameter customiseParameter(Parameter parameter, ParameterInfo parameterInfo) {`
Original file line number	Diff line number	Diff line change
`@@ -93,7 +93,7 @@ public static boolean isFile(Class type) {`
`93`	`93`	`return FILE_TYPES.stream().anyMatch(clazz -> clazz.isAssignableFrom(type));`
`94`	`94`	`}`
`95`	`95`
`96`		`- Parameter mergeParameter(List<Parameter> existingParamDoc, Parameter paramCalcul) {`
	`96`	`+ public static Parameter mergeParameter(List<Parameter> existingParamDoc, Parameter paramCalcul) {`
`97`	`97`	`Parameter result = paramCalcul;`
`98`	`98`	`if (paramCalcul != null && paramCalcul.getName() != null) {`
`99`	`99`	`final String name = paramCalcul.getName();`
`@@ -108,7 +108,7 @@ Parameter mergeParameter(List<Parameter> existingParamDoc, Parameter paramCalcul`
`108`	`108`	`return result;`
`109`	`109`	`}`
`110`	`110`
`111`		`- private void mergeParameter(Parameter paramCalcul, Parameter paramDoc) {`
	`111`	`+ private static void mergeParameter(Parameter paramCalcul, Parameter paramDoc) {`
`112`	`112`	`if (StringUtils.isBlank(paramDoc.getDescription()))`
`113`	`113`	`paramDoc.setDescription(paramCalcul.getDescription());`
`114`	`114`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ public List<RouterFunctionData> getRouterFunctionDatas() {`
`57`	`57`	`}`
`58`	`58`
`59`	`59`	`public void queryParam(String name, String value) {`
`60`		`- // Not yet needed`
	`60`	`+ routerFunctionData.addQueryParams(name, value);`
`61`	`61`	`}`
`62`	`62`
`63`	`63`	`public void pathExtension(String extension) {`
`@@ -100,7 +100,4 @@ public void endNegate() {`
`100`	`100`	`// Not yet needed`
`101`	`101`	`}`
`102`	`102`
`103`		`-`
`104`		`-`
`105`		`-`
`106`	`103`	`}`