Add support for Spring Cloud Function Web. Fixes #1299

Author: bnasslahsen

pom.xml

@@ -79,6 +79,7 @@
 		<jjwt.version>0.9.1</jjwt.version>
 		<spring-native.version>0.11.0</spring-native.version>
 		<therapi-runtime-javadoc.version>0.12.0</therapi-runtime-javadoc.version>
+		<spring-cloud.version>2021.0.0</spring-cloud.version>
 	</properties>
 
 	<dependencyManagement>
@@ -211,6 +212,13 @@
 				<artifactId>springdoc-openapi-javadoc</artifactId>
 				<version>${version}</version>
 			</dependency>
+			<dependency>
+				<groupId>org.springframework.cloud</groupId>
+				<artifactId>spring-cloud-dependencies</artifactId>
+				<version>${spring-cloud.version}</version>
+				<type>pom</type>
+				<scope>import</scope>
+			</dependency>
 		</dependencies>
 	</dependencyManagement>
 	<dependencies>

springdoc-openapi-common/pom.xml

@@ -52,6 +52,12 @@
 			<artifactId>spring-data-commons</artifactId>
 			<optional>true</optional>
 		</dependency>
+		<!-- For Spring Cloud Function Support -->
+		<dependency>
+			<groupId>org.springframework.cloud</groupId>
+			<artifactId>spring-cloud-function-web</artifactId>
+			<optional>true</optional>
+		</dependency>
 	</dependencies>
 	<build>
 		<plugins>

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

@@ -76,22 +76,23 @@
 import org.springdoc.api.mixins.SortedOpenAPIMixin;
 import org.springdoc.api.mixins.SortedSchemaMixin;
 import org.springdoc.core.AbstractRequestService;
-import org.springdoc.core.ActuatorProvider;
 import org.springdoc.core.GenericParameterService;
 import org.springdoc.core.GenericResponseService;
-import org.springdoc.core.JavadocProvider;
 import org.springdoc.core.MethodAttributes;
 import org.springdoc.core.OpenAPIService;
 import org.springdoc.core.OperationService;
 import org.springdoc.core.SpringDocConfigProperties;
 import org.springdoc.core.SpringDocConfigProperties.GroupConfig;
+import org.springdoc.core.SpringDocProviders;
 import org.springdoc.core.annotations.RouterOperations;
 import org.springdoc.core.customizers.OpenApiCustomiser;
 import org.springdoc.core.customizers.OpenApiLocaleCustomizer;
 import org.springdoc.core.customizers.OperationCustomizer;
 import org.springdoc.core.fn.AbstractRouterFunctionVisitor;
 import org.springdoc.core.fn.RouterFunctionData;
 import org.springdoc.core.fn.RouterOperation;
+import org.springdoc.core.providers.ActuatorProvider;
+import org.springdoc.core.providers.JavadocProvider;
 
 import org.springframework.aop.support.AopUtils;
 import org.springframework.beans.factory.ObjectFactory;
@@ -152,11 +153,6 @@ public abstract class AbstractOpenApiResource extends SpecFilter {
 	 */
 	protected final SpringDocConfigProperties springDocConfigProperties;
 
-	/**
-	 * The Actuator provider.
-	 */
-	protected final Optional<ActuatorProvider> optionalActuatorProvider;
-
 	/**
 	 * The Request builder.
 	 */
@@ -202,6 +198,11 @@ public abstract class AbstractOpenApiResource extends SpecFilter {
 	 */
 	private final Map<String, OpenApiLocaleCustomizer> openApiLocaleCustomizers;
 
+	/**
+	 * The Spring doc providers.
+	 */
+	protected final SpringDocProviders springDocProviders;
+
 	static {
 		try {
 			modelAndViewClass = Class.forName("org.springframework.web.servlet.ModelAndView");
@@ -213,7 +214,6 @@ public abstract class AbstractOpenApiResource extends SpecFilter {
 
 	/**
 	 * Instantiates a new Abstract open api resource.
-	 *
 	 * @param groupName the group name
 	 * @param openAPIBuilderObjectFactory the open api builder object factory
 	 * @param requestBuilder the request builder
@@ -222,15 +222,14 @@ public abstract class AbstractOpenApiResource extends SpecFilter {
 	 * @param operationCustomizers the operation customizers
 	 * @param openApiCustomisers the open api customisers
 	 * @param springDocConfigProperties the spring doc config properties
-	 * @param actuatorProvider the actuator provider
+	 * @param springDocProviders the spring doc providers
 	 */
 	protected AbstractOpenApiResource(String groupName, ObjectFactory<OpenAPIService> openAPIBuilderObjectFactory,
 			AbstractRequestService requestBuilder,
 			GenericResponseService responseBuilder, OperationService operationParser,
 			Optional<List<OperationCustomizer>> operationCustomizers,
 			Optional<List<OpenApiCustomiser>> openApiCustomisers,
-			SpringDocConfigProperties springDocConfigProperties,
-			Optional<ActuatorProvider> actuatorProvider) {
+			SpringDocConfigProperties springDocConfigProperties, SpringDocProviders springDocProviders) {
 		super();
 		this.groupName = Objects.requireNonNull(groupName, "groupName");
 		this.openAPIBuilderObjectFactory = openAPIBuilderObjectFactory;
@@ -239,14 +238,14 @@ protected AbstractOpenApiResource(String groupName, ObjectFactory<OpenAPIService
 		this.responseBuilder = responseBuilder;
 		this.operationParser = operationParser;
 		this.openApiCustomisers = openApiCustomisers;
+		this.springDocProviders = springDocProviders;
 		//add the default customizers
 		Map<String, OpenApiCustomiser> existingOpenApiCustomisers = openAPIService.getContext().getBeansOfType(OpenApiCustomiser.class);
 		if (!CollectionUtils.isEmpty(existingOpenApiCustomisers) && existingOpenApiCustomisers.containsKey(LINKS_SCHEMA_CUSTOMISER))
 			openApiCustomisers.ifPresent(openApiCustomisersList -> openApiCustomisersList.add(existingOpenApiCustomisers.get(LINKS_SCHEMA_CUSTOMISER)));
 		this.springDocConfigProperties = springDocConfigProperties;
 		operationCustomizers.ifPresent(customizers -> customizers.removeIf(Objects::isNull));
 		this.operationCustomizers = operationCustomizers;
-		this.optionalActuatorProvider = actuatorProvider;
 		if (springDocConfigProperties.isPreLoadingEnabled())
 			Executors.newSingleThreadExecutor().execute(this::getOpenApi);
 		this.openApiLocaleCustomizers = openAPIService.getContext().getBeansOfType(OpenApiLocaleCustomizer.class);
@@ -321,6 +320,13 @@ protected synchronized OpenAPI getOpenApi(Locale locale) {
 				responseBuilder.buildGenericResponse(openApi.getComponents(), findControllerAdvice, finalLocale);
 			}
 			getPaths(mappingsMap, finalLocale);
+
+			if (springDocProviders.getSpringCloudFunctionProvider().isPresent()) {
+				List<RouterOperation> routerOperationList = springDocProviders.getSpringCloudFunctionProvider().get().getRouterOperations(openApi);
+				if (!CollectionUtils.isEmpty(routerOperationList))
+					this.calculatePath(routerOperationList, locale);
+			}
+
 			if (!CollectionUtils.isEmpty(openApi.getServers()))
 				openAPIService.setServersPresent(true);
 			openAPIService.updateServers(openApi);
@@ -1117,6 +1123,7 @@ else if (existingOperation != null) {
 
 	/**
 	 * Init open api builder.
+	 * @param locale the locale
 	 */
 	protected void initOpenAPIBuilder(Locale locale) {
 		locale = locale == null ? Locale.getDefault() : locale;
@@ -1157,8 +1164,8 @@ protected URI getActuatorURI(String scheme, String host) {
 		int port;
 		String path;
 		URI uri = null;
-		if (optionalActuatorProvider.isPresent()) {
-			ActuatorProvider actuatorProvider = optionalActuatorProvider.get();
+		if (springDocProviders.getActuatorProvider().isPresent()) {
+			ActuatorProvider actuatorProvider = springDocProviders.getActuatorProvider().get();
 			if (ACTUATOR_DEFAULT_GROUP.equals(this.groupName)) {
 				port = actuatorProvider.getActuatorPort();
 				path = actuatorProvider.getActuatorPath();
@@ -1187,7 +1194,7 @@ protected URI getActuatorURI(String scheme, String host) {
 	 * @return the boolean
 	 */
 	protected boolean isShowActuator() {
-		return springDocConfigProperties.isShowActuator() && optionalActuatorProvider.isPresent();
+		return springDocConfigProperties.isShowActuator() && springDocProviders.getActuatorProvider().isPresent();
 	}
 
 	/**
@@ -1198,7 +1205,7 @@ protected boolean isShowActuator() {
 	 * @return the boolean
 	 */
 	protected boolean isActuatorRestController(String operationPath, HandlerMethod handlerMethod) {
-		return isShowActuator() && optionalActuatorProvider.get().isRestController(operationPath, handlerMethod);
+		return isShowActuator() && springDocProviders.getActuatorProvider().get().isRestController(operationPath, handlerMethod);
 	}
 
 	/**
@@ -1281,6 +1288,11 @@ enum ConditionType {
 		HEADERS
 	}
 
+	/**
+	 * Sort output.
+	 *
+	 * @param objectMapper the object mapper
+	 */
 	private void sortOutput(ObjectMapper objectMapper) {
 		objectMapper.configure(SerializationFeature.ORDER_MAP_ENTRIES_BY_KEYS, true);
 		objectMapper.configure(MapperFeature.SORT_PROPERTIES_ALPHABETICALLY, true);

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

@@ -61,6 +61,7 @@
 import org.apache.commons.lang3.StringUtils;
 import org.apache.commons.lang3.reflect.FieldUtils;
 import org.springdoc.core.customizers.ParameterCustomizer;
+import org.springdoc.core.providers.JavadocProvider;
 
 import org.springframework.core.LocalVariableTableParameterNameDiscoverer;
 import org.springframework.core.MethodParameter;
@@ -249,7 +250,7 @@ public Operation build(HandlerMethod handlerMethod, RequestMethod requestMethod,
 					io.swagger.v3.oas.annotations.Parameter.class);
 
 			final String pName = methodParameter.getParameterName();
-			ParameterInfo parameterInfo = new ParameterInfo(pName, methodParameter, parameterBuilder, methodAttributes.getLocale());
+			ParameterInfo parameterInfo = new ParameterInfo(pName, methodParameter, parameterBuilder);
 
 			if (parameterDoc == null)
 				parameterDoc = parametersDocMap.get(parameterInfo.getpName());

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

@@ -50,6 +50,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springdoc.core.customizers.DelegatingMethodParameterCustomizer;
+import org.springdoc.core.providers.WebConversionServiceProvider;
 
 import org.springframework.beans.factory.config.BeanExpressionContext;
 import org.springframework.beans.factory.config.BeanExpressionResolver;

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

@@ -49,6 +49,7 @@
 import org.apache.commons.lang3.StringUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.springdoc.core.providers.JavadocProvider;
 
 import org.springframework.core.MethodParameter;
 import org.springframework.core.ResolvableType;

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

@@ -48,6 +48,7 @@
 import io.swagger.v3.oas.models.responses.ApiResponse;
 import io.swagger.v3.oas.models.responses.ApiResponses;
 import org.apache.commons.lang3.StringUtils;
+import org.springdoc.core.providers.JavadocProvider;
 
 import org.springframework.core.annotation.AnnotationUtils;
 import org.springframework.util.CollectionUtils;

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

@@ -21,7 +21,6 @@
 package org.springdoc.core;
 
 import java.lang.reflect.Parameter;
-import java.util.Locale;
 
 import io.swagger.v3.oas.annotations.enums.ParameterIn;
 import org.apache.commons.lang3.StringUtils;
@@ -87,9 +86,8 @@ public class ParameterInfo {
 	 * @param pName the parameter name
 	 * @param methodParameter the method parameter
 	 * @param genericParameterService the parameter builder
-	 * @param locale the locale
 	 */
-	public ParameterInfo(String pName, MethodParameter methodParameter, GenericParameterService genericParameterService, Locale locale) {
+	public ParameterInfo(String pName, MethodParameter methodParameter, GenericParameterService genericParameterService) {
 		RequestHeader requestHeader = methodParameter.getParameterAnnotation(RequestHeader.class);
 		RequestParam requestParam = methodParameter.getParameterAnnotation(RequestParam.class);
 		PathVariable pathVar = methodParameter.getParameterAnnotation(PathVariable.class);

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

@@ -51,6 +51,14 @@
 import org.springdoc.core.customizers.OpenApiCustomiser;
 import org.springdoc.core.customizers.OperationCustomizer;
 import org.springdoc.core.customizers.PropertyCustomizer;
+import org.springdoc.core.providers.ActuatorProvider;
+import org.springdoc.core.providers.CloudFunctionProvider;
+import org.springdoc.core.providers.JavadocProvider;
+import org.springdoc.core.providers.RepositoryRestResourceProvider;
+import org.springdoc.core.providers.RouterFunctionProvider;
+import org.springdoc.core.providers.SecurityOAuth2Provider;
+import org.springdoc.core.providers.WebConversionServiceProvider;
+import org.springdoc.core.providers.impl.SpringCloudFunctionProvider;
 
 import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
 import org.springframework.beans.factory.config.ConfigurableBeanFactory;
@@ -63,6 +71,8 @@
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
 import org.springframework.boot.autoconfigure.web.format.WebConversionService;
+import org.springframework.cloud.function.context.FunctionCatalog;
+import org.springframework.cloud.function.web.function.FunctionEndpointInitializer;
 import org.springframework.context.ApplicationContext;
 import org.springframework.context.MessageSource;
 import org.springframework.context.annotation.Bean;
@@ -351,6 +361,24 @@ static BeanFactoryPostProcessor springdocBeanFactoryPostProcessor2() {
 		return SpringdocBeanFactoryConfigurer::initBeanFactoryPostProcessor;
 	}
 
+
+	/**
+	 * Spring doc providers spring doc providers.
+	 *
+	 * @param actuatorProvider the actuator provider
+	 * @param springCloudFunctionProvider the spring cloud function provider
+	 * @param springSecurityOAuth2Provider the spring security o auth 2 provider
+	 * @param repositoryRestResourceProvider the repository rest resource provider
+	 * @param routerFunctionProvider the router function provider
+	 * @return the spring doc providers
+	 */
+	@Bean
+	@ConditionalOnMissingBean
+	@Lazy(false)
+	SpringDocProviders springDocProviders(Optional<ActuatorProvider> actuatorProvider, Optional<CloudFunctionProvider> springCloudFunctionProvider, Optional<SecurityOAuth2Provider> springSecurityOAuth2Provider, Optional<RepositoryRestResourceProvider> repositoryRestResourceProvider, Optional<RouterFunctionProvider> routerFunctionProvider) {
+		return new SpringDocProviders(actuatorProvider, springCloudFunctionProvider, springSecurityOAuth2Provider, repositoryRestResourceProvider, routerFunctionProvider);
+	}
+
 	/**
 	 * The type Open api resource advice.
 	 * @author bnasslashen
@@ -462,4 +490,27 @@ PageableOpenAPIConverter pageableOpenAPIConverter() {
 		}
 	}
 
+	/**
+	 * The type Spring doc function catalog configuration.
+	 */
+	@ConditionalOnClass(FunctionEndpointInitializer.class)
+	static class SpringDocFunctionCatalogConfiguration {
+
+		/**
+		 * Spring cloud function provider spring cloud function provider.
+		 *
+		 * @param functionCatalog the function catalog
+		 * @param genericResponseService the generic response service
+		 * @param springDocConfigProperties the spring doc config properties
+		 * @param applicationContext the application context
+		 * @return the spring cloud function provider
+		 */
+		@Bean
+		@ConditionalOnMissingBean
+		@ConditionalOnWebApplication
+		@Lazy(false)
+		CloudFunctionProvider springCloudFunctionProvider(Optional<FunctionCatalog> functionCatalog,  GenericResponseService genericResponseService, SpringDocConfigProperties springDocConfigProperties, ApplicationContext applicationContext) {
+			return new SpringCloudFunctionProvider(functionCatalog, genericResponseService, springDocConfigProperties, applicationContext);
+		}
+	}
 }