Improve support of Webflux with Functional Endpoints

Author: bnasslahsen

springdoc-openapi-common/src/main/java/org/springdoc/api/AbstractOpenApiResource.java

@@ -46,6 +46,7 @@
 import io.swagger.v3.oas.models.PathItem;
 import io.swagger.v3.oas.models.PathItem.HttpMethod;
 import io.swagger.v3.oas.models.Paths;
+import io.swagger.v3.oas.models.media.StringSchema;
 import io.swagger.v3.oas.models.responses.ApiResponses;
 import org.apache.commons.lang3.ArrayUtils;
 import org.apache.commons.lang3.StringUtils;
@@ -258,6 +259,12 @@ protected void calculatePath(String operationPath, Set<RequestMethod> requestMet
 			Operation operation = (existingOperation != null) ? existingOperation : new Operation();
 			if (apiOperation != null)
 				openAPI = operationParser.parse(apiOperation, operation, openAPI, methodAttributes);
+			if (!CollectionUtils.isEmpty(operation.getParameters()))
+				operation.getParameters().forEach(parameter -> {
+							if (parameter.getSchema() == null)
+								parameter.setSchema(new StringSchema());
+						}
+				);
 			PathItem pathItemObject = buildPathItem(requestMethod, operation, operationPath, paths);
 			paths.addPathItem(operationPath, pathItemObject);
 		}
@@ -582,13 +589,13 @@ && isEqualArrays(routerFunctionData1.getConsumes(), routerOperation.getConsumes(
 	private boolean isEqualArrays(String[] array1, String[] array2) {
 		Arrays.sort(array1);
 		Arrays.sort(array2);
-		return Arrays.equals(array1,array2);
+		return Arrays.equals(array1, array2);
 	}
 
 	private boolean isEqualMethods(RequestMethod[] requestMethods1, RequestMethod[] requestMethods2) {
 		Arrays.sort(requestMethods1);
 		Arrays.sort(requestMethods2);
-		return Arrays.equals(requestMethods1,requestMethods2);
+		return Arrays.equals(requestMethods1, requestMethods2);
 	}
 
 	private void fillRouterOperation(RouterFunctionData routerFunctionData, org.springdoc.core.models.RouterOperation routerOperation) {

springdoc-openapi-webflux-core/src/test/java/test/org/springdoc/api/app71/EmployeeFunctionalConfig.java

@@ -41,7 +41,7 @@ RouterFunction<ServerResponse> getAllEmployeesRoute() {
 
 	@Bean
 	@RouterOperation(operation = @Operation(operationId = "findEmployeeById", summary = "Find purchase order by ID", tags = { "MyEmployee" },
-			parameters = { @Parameter(in = ParameterIn.PATH, name = "id", description = "Employee Id", schema = @Schema(type = "string")) },
+			parameters = { @Parameter(in = ParameterIn.PATH, name = "id", description = "Employee Id") },
 			responses = { @ApiResponse(responseCode = "200", description = "successful operation", content = @Content(schema = @Schema(implementation = Employee.class))),
 					@ApiResponse(responseCode = "400", description = "Invalid Employee ID supplied"),
 					@ApiResponse(responseCode = "404", description = "Employee not found") }))

springdoc-openapi-webflux-core/src/test/java/test/org/springdoc/api/app72/controller/PositionRouter.java

@@ -31,11 +31,11 @@ public class PositionRouter {
 	@Bean
 	@RouterOperations({ @RouterOperation(path = "/getAllPositions", operation = @Operation(description = "Get all positions", operationId = "findAll",tags = "positions",
 			responses = @ApiResponse(responseCode = "200", content = @Content(array = @ArraySchema(schema = @Schema(implementation = Position.class)))))),
-			@RouterOperation(path = "/getPosition/{id}", operation = @Operation(description = "Find all", operationId = "findById", tags = "positions",parameters = @Parameter(name = "id", in = ParameterIn.PATH, schema = @Schema(type = "string")),
+			@RouterOperation(path = "/getPosition/{id}", operation = @Operation(description = "Find all", operationId = "findById", tags = "positions",parameters = @Parameter(name = "id", in = ParameterIn.PATH),
 					 responses = @ApiResponse(responseCode = "200", content = @Content(schema = @Schema(implementation = Position.class))))),
 			@RouterOperation(path = "/createPosition",  operation = @Operation(description = "Save position", operationId = "save", tags = "positions",requestBody = @RequestBody(content = @Content(schema = @Schema(implementation = Position.class))),
 					responses = @ApiResponse(responseCode = "200", content = @Content(schema = @Schema(implementation = Position.class))))),
-			@RouterOperation(path = "/deletePosition/{id}", operation = @Operation(description = "Delete By Id", operationId = "deleteBy",tags = "positions", parameters = @Parameter(name = "id", in = ParameterIn.PATH, schema = @Schema(type = "string")),
+			@RouterOperation(path = "/deletePosition/{id}", operation = @Operation(description = "Delete By Id", operationId = "deleteBy",tags = "positions", parameters = @Parameter(name = "id", in = ParameterIn.PATH),
 					responses = @ApiResponse(responseCode = "200", content = @Content)))})
 	public RouterFunction<ServerResponse> positionRoute(PositionHandler handler) {
 		return RouterFunctions

springdoc-openapi-webflux-core/src/test/java/test/org/springdoc/api/app75/Post.java

@@ -0,0 +1,70 @@
+/*
+ *
+ *  *
+ *  *  * Copyright 2019-2020 the original author or authors.
+ *  *  *
+ *  *  * Licensed under the Apache License, Version 2.0 (the "License");
+ *  *  * you may not use this file except in compliance with the License.
+ *  *  * You may obtain a copy of the License at
+ *  *  *
+ *  *  *      https://www.apache.org/licenses/LICENSE-2.0
+ *  *  *
+ *  *  * Unless required by applicable law or agreed to in writing, software
+ *  *  * distributed under the License is distributed on an "AS IS" BASIS,
+ *  *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  *  * See the License for the specific language governing permissions and
+ *  *  * limitations under the License.
+ *  *
+ *
+ */
+
+package test.org.springdoc.api.app75;
+
+import java.time.LocalDateTime;
+
+public class Post {
+
+	private String id;
+	private String title;
+	private String content;
+	private LocalDateTime createdDate;
+
+	public Post(String id, String title, String content) {
+		this.id = id;
+		this.title = title;
+		this.content = content;
+		this.createdDate =  LocalDateTime.now();
+	}
+
+	public String getId() {
+		return id;
+	}
+
+	public void setId(String id) {
+		this.id = id;
+	}
+
+	public String getTitle() {
+		return title;
+	}
+
+	public void setTitle(String title) {
+		this.title = title;
+	}
+
+	public String getContent() {
+		return content;
+	}
+
+	public void setContent(String content) {
+		this.content = content;
+	}
+
+	public LocalDateTime getCreatedDate() {
+		return createdDate;
+	}
+
+	public void setCreatedDate(LocalDateTime createdDate) {
+		this.createdDate = createdDate;
+	}
+}

springdoc-openapi-webflux-core/src/test/java/test/org/springdoc/api/app75/PostHandler.java

@@ -0,0 +1,77 @@
+/*
+ *
+ *  *
+ *  *  * Copyright 2019-2020 the original author or authors.
+ *  *  *
+ *  *  * Licensed under the Apache License, Version 2.0 (the "License");
+ *  *  * you may not use this file except in compliance with the License.
+ *  *  * You may obtain a copy of the License at
+ *  *  *
+ *  *  *      https://www.apache.org/licenses/LICENSE-2.0
+ *  *  *
+ *  *  * Unless required by applicable law or agreed to in writing, software
+ *  *  * distributed under the License is distributed on an "AS IS" BASIS,
+ *  *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  *  * See the License for the specific language governing permissions and
+ *  *  * limitations under the License.
+ *  *
+ *
+ */
+
+package test.org.springdoc.api.app75;
+
+
+import java.net.URI;
+
+import reactor.core.publisher.Mono;
+
+import org.springframework.stereotype.Component;
+import org.springframework.web.reactive.function.server.ServerRequest;
+import org.springframework.web.reactive.function.server.ServerResponse;
+
+@Component
+class PostHandler {
+
+	private final PostRepository posts;
+
+	public PostHandler(PostRepository posts) {
+		this.posts = posts;
+	}
+
+	public Mono<ServerResponse> all(ServerRequest req) {
+		return ServerResponse.ok().body(this.posts.findAll(), Post.class);
+	}
+
+	public Mono<ServerResponse> create(ServerRequest req) {
+		return req.bodyToMono(Post.class)
+				.flatMap(post -> this.posts.save(post))
+				.flatMap(p -> ServerResponse.created(URI.create("/posts/" + p.getId())).build());
+	}
+
+	public Mono<ServerResponse> get(ServerRequest req) {
+		return this.posts.findById(req.pathVariable("id"))
+				.flatMap(post -> ServerResponse.ok().body(Mono.just(post), Post.class))
+				.switchIfEmpty(ServerResponse.notFound().build());
+	}
+
+	public Mono<ServerResponse> update(ServerRequest req) {
+
+		return Mono
+				.zip(
+						(data) -> {
+							Post p = (Post) data[0];
+							Post p2 = (Post) data[1];
+							p.setTitle(p2.getTitle());
+							p.setContent(p2.getContent());
+							return p;
+						},
+						this.posts.findById(req.pathVariable("id")),
+						req.bodyToMono(Post.class)
+				)
+				.cast(Post.class)
+				.flatMap(post -> this.posts.save(post))
+				.flatMap(post -> ServerResponse.noContent().build());
+
+	}
+
+}

springdoc-openapi-webflux-core/src/test/java/test/org/springdoc/api/app75/PostRepository.java

@@ -0,0 +1,47 @@
+/*
+ *
+ *  *
+ *  *  * Copyright 2019-2020 the original author or authors.
+ *  *  *
+ *  *  * Licensed under the Apache License, Version 2.0 (the "License");
+ *  *  * you may not use this file except in compliance with the License.
+ *  *  * You may obtain a copy of the License at
+ *  *  *
+ *  *  *      https://www.apache.org/licenses/LICENSE-2.0
+ *  *  *
+ *  *  * Unless required by applicable law or agreed to in writing, software
+ *  *  * distributed under the License is distributed on an "AS IS" BASIS,
+ *  *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  *  * See the License for the specific language governing permissions and
+ *  *  * limitations under the License.
+ *  *
+ *
+ */
+
+package test.org.springdoc.api.app75;
+
+import reactor.core.publisher.Flux;
+import reactor.core.publisher.Mono;
+
+import org.springframework.stereotype.Component;
+
+@Component
+public class PostRepository {
+
+	public Flux<Post> findByAuthor(String author) {
+		return Flux.just(new Post("1", "title1", "author1"));
+	}
+
+	public Flux<Post> findAll() {
+		return Flux.just(new Post("2", "title2", "author2"));
+	}
+
+	public Mono<Post> findById(String id) {
+		return Mono.just(new Post("3", "title2", "author2"));
+	}
+
+	public Mono<Post> save(Post post) {
+		return Mono.just(new Post("4", "title2", "author2"));
+	}
+
+}

springdoc-openapi-webflux-core/src/test/java/test/org/springdoc/api/app75/PostRouter.java

@@ -0,0 +1,65 @@
+/*
+ *
+ *  *
+ *  *  * Copyright 2019-2020 the original author or authors.
+ *  *  *
+ *  *  * Licensed under the Apache License, Version 2.0 (the "License");
+ *  *  * you may not use this file except in compliance with the License.
+ *  *  * You may obtain a copy of the License at
+ *  *  *
+ *  *  *      https://www.apache.org/licenses/LICENSE-2.0
+ *  *  *
+ *  *  * Unless required by applicable law or agreed to in writing, software
+ *  *  * distributed under the License is distributed on an "AS IS" BASIS,
+ *  *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  *  * See the License for the specific language governing permissions and
+ *  *  * limitations under the License.
+ *  *
+ *
+ */
+
+package test.org.springdoc.api.app75;
+
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.enums.ParameterIn;
+import io.swagger.v3.oas.annotations.media.ArraySchema;
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.media.Schema;
+import io.swagger.v3.oas.annotations.parameters.RequestBody;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import org.springdoc.core.annotations.RouterOperation;
+import org.springdoc.core.annotations.RouterOperations;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.web.bind.annotation.RequestMethod;
+import org.springframework.web.reactive.function.server.RouterFunction;
+import org.springframework.web.reactive.function.server.ServerResponse;
+
+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.RouterFunctions.route;
+
+@Configuration
+class PostRouter {
+
+	@RouterOperations({ @RouterOperation(path = "/posts", method = RequestMethod.GET, operation = @Operation(operationId = "all",
+			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"))),
+			@RouterOperation(path = "/posts/{id}", method = RequestMethod.GET, operation = @Operation(operationId = "get",
+					parameters = @Parameter(name = "id", in = ParameterIn.PATH),
+					responses = @ApiResponse(responseCode = "200", content = @Content(schema = @Schema(implementation = Post.class))))),
+			@RouterOperation(path = "/posts/{id}", method = RequestMethod.PUT, operation = @Operation(operationId = "update",
+					parameters = @Parameter(name = "id", in = ParameterIn.PATH),
+					responses = @ApiResponse(responseCode = "202", content = @Content(schema = @Schema(implementation = Post.class))))) })
+	@Bean
+	public RouterFunction<ServerResponse> routes(PostHandler postController) {
+		return route(GET("/posts"), postController::all)
+				.andRoute(POST("/posts"), postController::create)
+				.andRoute(GET("/posts/{id}"), postController::get)
+				.andRoute(PUT("/posts/{id}"), postController::update);
+	}
+}

springdoc-openapi-webflux-core/src/test/java/test/org/springdoc/api/app75/SpringDocApp75Test.java

@@ -0,0 +1,33 @@
+/*
+ *
+ *  *
+ *  *  * Copyright 2019-2020 the original author or authors.
+ *  *  *
+ *  *  * Licensed under the Apache License, Version 2.0 (the "License");
+ *  *  * you may not use this file except in compliance with the License.
+ *  *  * You may obtain a copy of the License at
+ *  *  *
+ *  *  *      https://www.apache.org/licenses/LICENSE-2.0
+ *  *  *
+ *  *  * Unless required by applicable law or agreed to in writing, software
+ *  *  * distributed under the License is distributed on an "AS IS" BASIS,
+ *  *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  *  * See the License for the specific language governing permissions and
+ *  *  * limitations under the License.
+ *  *
+ *
+ */
+
+package test.org.springdoc.api.app75;
+
+import test.org.springdoc.api.AbstractSpringDocTest;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.context.annotation.ComponentScan;
+
+public class SpringDocApp75Test extends AbstractSpringDocTest {
+
+	@SpringBootApplication
+	@ComponentScan(basePackages = { "org.springdoc", "test.org.springdoc.api.app75" })
+	static class SpringDocTestApp {}
+}