add property springdoc.show-spring-cloud-functions

Author: bnasslahsen

springdoc-openapi-common/src/main/java/org/springdoc/core/Constants.java

@@ -140,6 +140,11 @@ public final class Constants {
 	 */
 	public static final String SPRINGDOC_SHOW_ACTUATOR = "springdoc.show-actuator";
 
+	/**
+	 * The constant SPRINGDOC_SHOW_SPRING_CLOUD_FUNCTIONS.
+	 */
+	public static final String SPRINGDOC_SHOW_SPRING_CLOUD_FUNCTIONS = "springdoc.show-spring-cloud-functions";
+
 	/**
 	 * The constant SPRINGDOC_ACTUATOR_TAG.
 	 */

springdoc-openapi-common/src/main/java/org/springdoc/core/SpringDocConfigProperties.java

@@ -167,11 +167,34 @@ public class SpringDocConfigProperties {
 	 */
 	private boolean disableI18n;
 
+	/**
+	 * The Show spring cloud functions.
+	 */
+	private boolean showSpringCloudFunctions;
+
 	/**
 	 * The model Converters
 	 */
 	private ModelConverters modelConverters = new ModelConverters();
 
+	/**
+	 * Is show spring cloud functions boolean.
+	 *
+	 * @return the boolean
+	 */
+	public boolean isShowSpringCloudFunctions() {
+		return showSpringCloudFunctions;
+	}
+
+	/**
+	 * Sets show spring cloud functions.
+	 *
+	 * @param showSpringCloudFunctions the show spring cloud functions
+	 */
+	public void setShowSpringCloudFunctions(boolean showSpringCloudFunctions) {
+		this.showSpringCloudFunctions = showSpringCloudFunctions;
+	}
+
 	/**
 	 * Gets model converters.
 	 *

springdoc-openapi-common/src/main/java/org/springdoc/core/SpringDocConfiguration.java

@@ -95,6 +95,7 @@
 import static org.springdoc.core.Constants.SPRINGDOC_POLYMORPHIC_CONVERTER_ENABLED;
 import static org.springdoc.core.Constants.SPRINGDOC_SCHEMA_RESOLVE_PROPERTIES;
 import static org.springdoc.core.Constants.SPRINGDOC_SHOW_ACTUATOR;
+import static org.springdoc.core.Constants.SPRINGDOC_SHOW_SPRING_CLOUD_FUNCTIONS;
 import static org.springdoc.core.SpringDocUtils.getConfig;
 
 /**
@@ -494,6 +495,7 @@ PageableOpenAPIConverter pageableOpenAPIConverter() {
 	 * The type Spring doc function catalog configuration.
 	 */
 	@ConditionalOnClass(FunctionEndpointInitializer.class)
+	@ConditionalOnProperty(name=SPRINGDOC_SHOW_SPRING_CLOUD_FUNCTIONS, matchIfMissing = true)
 	static class SpringDocFunctionCatalogConfiguration {
 
 		/**

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app175/PersonDTO.java

@@ -0,0 +1,60 @@
+/*
+ *
+ *  * 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.app175;
+
+public class PersonDTO {
+	private String email;
+
+	private String firstName;
+
+	private String lastName;
+
+	public PersonDTO() {
+	}
+
+	public PersonDTO(final String email, final String firstName, final String lastName) {
+		this.email = email;
+		this.firstName = firstName;
+		this.lastName = lastName;
+	}
+
+	public String getEmail() {
+		return email;
+	}
+
+	public void setEmail(final String email) {
+		this.email = email;
+	}
+
+	public String getFirstName() {
+		return firstName;
+	}
+
+	public void setFirstName(final String firstName) {
+		this.firstName = firstName;
+	}
+
+	public String getLastName() {
+		return lastName;
+	}
+
+	public void setLastName(final String lastName) {
+		this.lastName = lastName;
+	}
+}

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app175/SpringDocApp175Test.java

@@ -0,0 +1,90 @@
+/*
+ *
+ *  * 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.app175;
+
+import java.util.function.Consumer;
+import java.util.function.Function;
+import java.util.function.Supplier;
+
+import io.swagger.v3.oas.annotations.Operation;
+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.responses.ApiResponse;
+import org.springdoc.core.annotations.RouterOperation;
+import org.springdoc.core.annotations.RouterOperations;
+import reactor.core.publisher.Flux;
+import test.org.springdoc.api.AbstractSpringDocTest;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.cloud.function.context.config.ContextFunctionCatalogAutoConfiguration;
+import org.springframework.cloud.function.web.mvc.ReactorAutoConfiguration;
+import org.springframework.cloud.function.web.source.FunctionExporterAutoConfiguration;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Import;
+import org.springframework.test.context.TestPropertySource;
+import org.springframework.web.bind.annotation.RequestMethod;
+
+@Import({ ReactorAutoConfiguration.class, FunctionExporterAutoConfiguration.class, ContextFunctionCatalogAutoConfiguration.class })
+@TestPropertySource(properties="springdoc.show-spring-cloud-functions=false")
+public class SpringDocApp175Test extends AbstractSpringDocTest {
+
+	@SpringBootApplication
+	static class SpringDocTestApp {
+		@Bean
+		public Function<String, String> reverseString() {
+			return value -> new StringBuilder(value).reverse().toString();
+		}
+
+		@Bean
+		public Function<String, String> uppercase() {
+			return value -> value.toUpperCase();
+		}
+
+		@Bean
+		@RouterOperations({
+				@RouterOperation(method = RequestMethod.GET, operation = @Operation(description = "Say hello GET", operationId = "lowercaseGET", tags = "positions",
+						responses = @ApiResponse(responseCode = "200", content = @Content(array = @ArraySchema(schema = @Schema(implementation = String.class)))))),
+				@RouterOperation(method = RequestMethod.POST, operation = @Operation(description = "Say hello POST", operationId = "lowercasePOST", tags = "positions",
+						responses = @ApiResponse(responseCode = "200", description = "new desc", content = @Content(array = @ArraySchema(schema = @Schema(implementation = String.class))))))
+		})
+		public Function<Flux<String>, Flux<String>> lowercase() {
+			return flux -> flux.map(value -> value.toLowerCase());
+		}
+
+		@Bean(name = "titi")
+		@RouterOperation(operation = @Operation(description = "Say hello By Id", operationId = "hellome", tags = "persons",
+				responses = @ApiResponse(responseCode = "200", content = @Content(schema = @Schema(implementation = PersonDTO.class)))))
+		public Supplier<PersonDTO> helloSupplier() {
+			return () -> new PersonDTO();
+		}
+
+		@Bean
+		public Consumer<PersonDTO> helloConsumer() {
+			return personDTO -> personDTO.getFirstName();
+		}
+
+		@Bean
+		public Supplier<Flux<String>> words() {
+			return () -> Flux.fromArray(new String[] { "foo", "bar" });
+		}
+
+	}
+
+}

springdoc-openapi-webmvc-core/src/test/resources/results/app175.json

@@ -0,0 +1,15 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "OpenAPI definition",
+    "version": "v0"
+  },
+  "servers": [
+    {
+      "url": "http://localhost",
+      "description": "Generated server url"
+    }
+  ],
+  "paths": {},
+  "components": {}
+}