Improve support of Webflux with Functional Endpoints

bnasslahsen · bnasslahsen · commit e7483a87e113 · 2020-05-03T18:24:00.000+02:00
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/GenericResponseBuilder.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/GenericResponseBuilder.java
@@ -167,9 +167,9 @@ public static void buildContentFromDoc(Components components, ApiResponses apiRe
 		if (apiResponsesOp.containsKey(apiResponseAnnotations.responseCode())) {
 			// Merge with the existing content
 			Content existingContent = apiResponsesOp.get(apiResponseAnnotations.responseCode()).getContent();
-			if (optionalContent.isPresent() && existingContent != null) {
+			if (optionalContent.isPresent()) {
 				Content newContent = optionalContent.get();
-				if (methodAttributes.isMethodOverloaded()) {
+				if (methodAttributes.isMethodOverloaded() && existingContent != null) {
 					Arrays.stream(methodAttributes.getMethodProduces()).filter(mediaTypeStr -> (newContent.get(mediaTypeStr) != null)).forEach(mediaTypeStr -> mergeSchema(existingContent, newContent.get(mediaTypeStr).getSchema(), mediaTypeStr));
 					apiResponse.content(existingContent);
 				}
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/OperationBuilder.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/OperationBuilder.java
@@ -295,13 +295,7 @@ private Optional<ApiResponses> getApiResponses(
 			setDescription(response, apiResponseObject);
 			setExtensions(response, apiResponseObject);
 
-			if (apiResponsesOp == null)
-				SpringDocAnnotationsUtils.getContent(response.content(),
-						classProduces == null ? new String[0] : classProduces,
-						methodProduces == null ? new String[0] : methodProduces, null, components, null)
-						.ifPresent(apiResponseObject::content);
-			else
-				GenericResponseBuilder.buildContentFromDoc(components, apiResponsesOp, methodAttributes, response, apiResponseObject);
+			buildResponseContent(methodAttributes, components, classProduces, methodProduces, apiResponsesOp, response, apiResponseObject);
 
 			AnnotationsUtils.getHeaders(response.headers(), null).ifPresent(apiResponseObject::headers);
 			// Make schema as string if empty
@@ -320,6 +314,16 @@ private Optional<ApiResponses> getApiResponses(
 		return Optional.of(apiResponsesObject);
 	}
 
+	private void buildResponseContent(MethodAttributes methodAttributes, Components components, String[] classProduces, String[] methodProduces, ApiResponses apiResponsesOp, io.swagger.v3.oas.annotations.responses.ApiResponse response, ApiResponse apiResponseObject) {
+		if (apiResponsesOp == null)
+			SpringDocAnnotationsUtils.getContent(response.content(),
+					classProduces == null ? new String[0] : classProduces,
+					methodProduces == null ? new String[0] : methodProduces, null, components, null)
+					.ifPresent(apiResponseObject::content);
+		else
+			GenericResponseBuilder.buildContentFromDoc(components, apiResponsesOp, methodAttributes, response, apiResponseObject);
+	}
+
 	private boolean isResponseObject(ApiResponse apiResponseObject) {
 		return StringUtils.isNotBlank(apiResponseObject.getDescription()) || apiResponseObject.getContent() != null
 				|| apiResponseObject.getHeaders() != null;
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/RequestBodyBuilder.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/RequestBodyBuilder.java
@@ -84,6 +84,12 @@ public Optional<RequestBody> buildRequestBodyFromDoc(
 		if (isEmpty)
 			return Optional.empty();
 
+		buildResquestBodyContent(requestBody, requestBodyOp, methodAttributes, components, jsonViewAnnotation, classConsumes, methodConsumes, requestBodyObject);
+
+		return Optional.of(requestBodyObject);
+	}
+
+	private void buildResquestBodyContent(io.swagger.v3.oas.annotations.parameters.RequestBody requestBody, RequestBody requestBodyOp, MethodAttributes methodAttributes, Components components, JsonView jsonViewAnnotation, String[] classConsumes, String[] methodConsumes, RequestBody requestBodyObject) {
 		Optional<Content> optionalContent = AnnotationsUtils
 				.getContent(requestBody.content(), classConsumes == null ? new String[0] : classConsumes,
 						methodConsumes == null ? new String[0] : methodConsumes, null, components, jsonViewAnnotation);
@@ -101,8 +107,6 @@ public Optional<RequestBody> buildRequestBodyFromDoc(
 					requestBodyObject.content(newContent);
 			}
 		}
-
-		return Optional.of(requestBodyObject);
 	}
 
 	public Optional<RequestBody> buildRequestBodyFromDoc(io.swagger.v3.oas.annotations.parameters.RequestBody requestBody,
diff --git a/springdoc-openapi-webflux-core/src/test/java/test/org/springdoc/api/app73/QuoteRouter.java b/springdoc-openapi-webflux-core/src/test/java/test/org/springdoc/api/app73/QuoteRouter.java
@@ -42,6 +42,7 @@
 import static org.springframework.http.MediaType.APPLICATION_STREAM_JSON;
 import static org.springframework.http.MediaType.APPLICATION_STREAM_JSON_VALUE;
 import static org.springframework.http.MediaType.TEXT_PLAIN;
+import static org.springframework.http.MediaType.TEXT_PLAIN_VALUE;
 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.accept;
@@ -50,8 +51,11 @@
 @Configuration
 public class QuoteRouter {
 
-	@RouterOperations({ @RouterOperation(path = "/hello", operation = @Operation(operationId = "hello", responses = @ApiResponse(responseCode = "200"))),
-			@RouterOperation(path = "/echo", operation = @Operation(operationId = "echo", requestBody = @RequestBody(content = @Content(schema = @Schema(type = "string"))),
+	@RouterOperations({
+			@RouterOperation(path = "/hello", operation = @Operation(operationId = "hello", responses = @ApiResponse(responseCode = "200"))),
+			@RouterOperation(path = "/echo", produces = TEXT_PLAIN_VALUE, operation = @Operation(operationId = "echo", requestBody = @RequestBody(content = @Content(schema = @Schema(type = "string"))),
+					responses = @ApiResponse(responseCode = "200", content = @Content(schema = @Schema(type = "string"))))),
+			@RouterOperation(path = "/echo",produces = APPLICATION_JSON_VALUE,  operation = @Operation(operationId = "echo", requestBody = @RequestBody(content = @Content(schema = @Schema(type = "string"))),
 					responses = @ApiResponse(responseCode = "200", content = @Content(schema = @Schema(type = "string"))))),
 			@RouterOperation(path = "/quotes", produces = APPLICATION_JSON_VALUE, operation = @Operation(operationId = "fetchQuotes", parameters = @Parameter(name = "size", in = ParameterIn.QUERY, schema = @Schema(type = "string")),
 					responses = @ApiResponse(responseCode = "200", content = @Content(array = @ArraySchema(schema = @Schema(implementation = Quote.class)))))),
@@ -62,6 +66,7 @@ public RouterFunction<ServerResponse> route(QuoteHandler quoteHandler) {
 		return RouterFunctions
 				.route(GET("/hello").and(accept(TEXT_PLAIN)), quoteHandler::hello)
 				.andRoute(POST("/echo").and(accept(TEXT_PLAIN).and(contentType(TEXT_PLAIN))), quoteHandler::echo)
+				.andRoute(POST("/echo").and(accept(APPLICATION_JSON).and(contentType(APPLICATION_JSON))), quoteHandler::echo)
 				.andRoute(GET("/quotes").and(accept(APPLICATION_JSON)), quoteHandler::fetchQuotes)
 				.andRoute(GET("/quotes").and(accept(APPLICATION_STREAM_JSON)), quoteHandler::streamQuotes);
 	}
diff --git a/springdoc-openapi-webflux-core/src/test/resources/results/app73.json b/springdoc-openapi-webflux-core/src/test/resources/results/app73.json
@@ -23,13 +23,18 @@
     },
     "/echo": {
       "post": {
-        "operationId": "echo",
+        "operationId": "echo_1",
         "requestBody": {
           "content": {
             "text/plain": {
               "schema": {
                 "type": "string"
               }
+            },
+            "application/json": {
+              "schema": {
+                "type": "string"
+              }
             }
           }
         },
@@ -41,6 +46,11 @@
                 "schema": {
                   "type": "string"
                 }
+              },
+              "application/json": {
+                "schema": {
+                  "type": "string"
+                }
               }
             }
           }
diff --git a/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app50/HelloController.java b/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app50/HelloController.java
@@ -21,7 +21,6 @@
 import java.util.List;
 
 import io.swagger.v3.oas.annotations.Operation;
-import io.swagger.v3.oas.annotations.media.Content;
 import io.swagger.v3.oas.annotations.responses.ApiResponse;
 
 import org.springframework.http.MediaType;
@@ -32,7 +31,7 @@
 public class HelloController {
 
 	@Operation(description = "Some operation", responses = { @ApiResponse(responseCode = "401") })
-	@ApiResponse(responseCode = "401", content = @Content())
+	//@ApiResponse(responseCode = "401", content = @Content())
 	@GetMapping(value = "/hello", produces = MediaType.APPLICATION_JSON_VALUE)
 	List<String> list() {
 		return null;

Original file line number	Diff line number	Diff line change
`@@ -84,6 +84,12 @@ public Optional<RequestBody> buildRequestBodyFromDoc(`
`84`	`84`	`if (isEmpty)`
`85`	`85`	`return Optional.empty();`
`86`	`86`
	`87`	`+ buildResquestBodyContent(requestBody, requestBodyOp, methodAttributes, components, jsonViewAnnotation, classConsumes, methodConsumes, requestBodyObject);`
	`88`	`+`
	`89`	`+ return Optional.of(requestBodyObject);`
	`90`	`+ }`
	`91`	`+`
	`92`	`+ private void buildResquestBodyContent(io.swagger.v3.oas.annotations.parameters.RequestBody requestBody, RequestBody requestBodyOp, MethodAttributes methodAttributes, Components components, JsonView jsonViewAnnotation, String[] classConsumes, String[] methodConsumes, RequestBody requestBodyObject) {`
`87`	`93`	`Optional<Content> optionalContent = AnnotationsUtils`
`88`	`94`	`.getContent(requestBody.content(), classConsumes == null ? new String[0] : classConsumes,`
`89`	`95`	`methodConsumes == null ? new String[0] : methodConsumes, null, components, jsonViewAnnotation);`
`@@ -101,8 +107,6 @@ public Optional<RequestBody> buildRequestBodyFromDoc(`
`101`	`107`	`requestBodyObject.content(newContent);`
`102`	`108`	`}`
`103`	`109`	`}`
`104`		`-`
`105`		`- return Optional.of(requestBodyObject);`
`106`	`110`	`}`
`107`	`111`
`108`	`112`	`public Optional<RequestBody> buildRequestBodyFromDoc(io.swagger.v3.oas.annotations.parameters.RequestBody requestBody,`
Original file line number	Diff line number	Diff line change
`@@ -23,13 +23,18 @@`
`23`	`23`	`},`
`24`	`24`	`"/echo": {`
`25`	`25`	`"post": {`
`26`		`- "operationId": "echo",`
	`26`	`+ "operationId": "echo_1",`
`27`	`27`	`"requestBody": {`
`28`	`28`	`"content": {`
`29`	`29`	`"text/plain": {`
`30`	`30`	`"schema": {`
`31`	`31`	`"type": "string"`
`32`	`32`	`}`
	`33`	`+ },`
	`34`	`+ "application/json": {`
	`35`	`+ "schema": {`
	`36`	`+ "type": "string"`
	`37`	`+ }`
`33`	`38`	`}`
`34`	`39`	`}`
`35`	`40`	`},`
`@@ -41,6 +46,11 @@`
`41`	`46`	`"schema": {`
`42`	`47`	`"type": "string"`
`43`	`48`	`}`
	`49`	`+ },`
	`50`	`+ "application/json": {`
	`51`	`+ "schema": {`
	`52`	`+ "type": "string"`
	`53`	`+ }`
`44`	`54`	`}`
`45`	`55`	`}`
`46`	`56`	`}`