Add global customizers and filters

Author: christophejan

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

@@ -49,10 +49,13 @@
 import org.springdoc.core.customizers.ActuatorOperationCustomizer;
 import org.springdoc.core.customizers.DataRestDelegatingMethodParameterCustomizer;
 import org.springdoc.core.customizers.DelegatingMethodParameterCustomizer;
+import org.springdoc.core.customizers.GlobalOpenApiCustomiser;
+import org.springdoc.core.customizers.GlobalOperationCustomizer;
 import org.springdoc.core.customizers.OpenApiBuilderCustomizer;
 import org.springdoc.core.customizers.OpenApiCustomiser;
 import org.springdoc.core.customizers.PropertyCustomizer;
 import org.springdoc.core.customizers.ServerBaseUrlCustomizer;
+import org.springdoc.core.filters.GlobalOpenApiMethodFilter;
 import org.springdoc.core.providers.ActuatorProvider;
 import org.springdoc.core.providers.CloudFunctionProvider;
 import org.springdoc.core.providers.JavadocProvider;
@@ -84,6 +87,7 @@
 import org.springframework.context.annotation.Conditional;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Lazy;
+import org.springframework.context.annotation.Scope;
 import org.springframework.core.LocalVariableTableParameterNameDiscoverer;
 import org.springframework.core.convert.support.GenericConversionService;
 import org.springframework.data.domain.Pageable;
@@ -397,6 +401,18 @@ SpringDocProviders springDocProviders(Optional<ActuatorProvider> actuatorProvide
 		return new SpringDocProviders(actuatorProvider, springCloudFunctionProvider, springSecurityOAuth2Provider, repositoryRestResourceProvider, routerFunctionProvider, springWebProvider);
 	}
 
+	@Bean
+	@Scope("prototype")
+	@ConditionalOnMissingBean
+	public GroupedOpenApi.Builder groupedOpenApiBuilder(List<GlobalOpenApiCustomiser> globalOpenApiCustomisers, List<GlobalOperationCustomizer> globalOperationCustomizers,
+			List<GlobalOpenApiMethodFilter> globalOpenApiMethodFilters) {
+		GroupedOpenApi.Builder builder = GroupedOpenApi.builder();
+		globalOpenApiCustomisers.forEach(builder::addOpenApiCustomiser);
+		globalOperationCustomizers.forEach(builder::addOperationCustomizer);
+		globalOpenApiMethodFilters.forEach(builder::addOpenApiMethodFilter);
+		return builder;
+	}
+
 	/**
 	 * The type Open api resource advice.
 	 * @author bnasslashen

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

@@ -84,6 +84,7 @@ public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) {
 			registry.registerBeanDefinition(ACTUATOR_DEFAULT_GROUP, BeanDefinitionBuilder
 					.genericBeanDefinition(SpringdocActuatorBeanFactoryConfigurer.class)
 					.setFactoryMethod("actuatorGroupFactoryMethod")
+					.addConstructorArgValue(new RuntimeBeanReference(GroupedOpenApi.Builder.class))
 					.addConstructorArgValue(webEndpointProperties.getBasePath())
 					.addConstructorArgValue(new RuntimeBeanReference(ActuatorOpenApiCustomizer.class))
 					.addConstructorArgValue(new RuntimeBeanReference(ActuatorOperationCustomizer.class))
@@ -94,6 +95,7 @@ public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) {
 				registry.registerBeanDefinition(DEFAULT_GROUP_NAME, BeanDefinitionBuilder
 						.genericBeanDefinition(SpringdocActuatorBeanFactoryConfigurer.class)
 						.setFactoryMethod("defaultGroupFactoryMethod")
+						.addConstructorArgValue(new RuntimeBeanReference(GroupedOpenApi.Builder.class))
 						.addConstructorArgValue(webEndpointProperties.getBasePath())
 						.getBeanDefinition());
 			}
@@ -108,15 +110,16 @@ public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)
 	/**
 	 * Actuator {@link GroupedOpenApi} factory method.
 	 *
+	 * @param builder the {@link GroupedOpenApi.Builder}
 	 * @param actuatorBasePath the actuator base path
 	 * @param actuatorOpenApiCustomiser the {@link ActuatorOpenApiCustomizer}
 	 * @param actuatorOperationCustomizer the {@link ActuatorOperationCustomizer}
 	 * 
 	 * @return the actuator {@link GroupedOpenApi}
 	 */
-	public static GroupedOpenApi actuatorGroupFactoryMethod(String actuatorBasePath,
+	public static GroupedOpenApi actuatorGroupFactoryMethod(GroupedOpenApi.Builder builder, String actuatorBasePath,
 			ActuatorOpenApiCustomizer actuatorOpenApiCustomiser, ActuatorOperationCustomizer actuatorOperationCustomizer) {
-		return GroupedOpenApi.builder().group(ACTUATOR_DEFAULT_GROUP)
+		return builder.group(ACTUATOR_DEFAULT_GROUP)
 				.pathsToMatch(actuatorBasePath + ALL_PATTERN)
 				.pathsToExclude(actuatorBasePath + HEALTH_PATTERN)
 				.addOpenApiCustomiser(actuatorOpenApiCustomiser)
@@ -127,12 +130,13 @@ public static GroupedOpenApi actuatorGroupFactoryMethod(String actuatorBasePath,
 	/**
 	 * Default {@link GroupedOpenApi} factory method.
 	 *
+	 * @param builder the {@link GroupedOpenApi.Builder}
 	 * @param actuatorBasePath the actuator base path
 	 * 
 	 * @return the default {@link GroupedOpenApi}
 	 */
-	public static GroupedOpenApi defaultGroupFactoryMethod(String actuatorBasePath) {
-		return GroupedOpenApi.builder().group(DEFAULT_GROUP_NAME)
+	public static GroupedOpenApi defaultGroupFactoryMethod(GroupedOpenApi.Builder builder, String actuatorBasePath) {
+		return builder.group(DEFAULT_GROUP_NAME)
 				.pathsToMatch(ALL_PATTERN)
 				.pathsToExclude(actuatorBasePath + ALL_PATTERN)
 				.build();

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

@@ -28,6 +28,7 @@
 import org.springdoc.core.SpringDocConfigProperties.GroupConfig;
 import org.springframework.beans.BeansException;
 import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
+import org.springframework.beans.factory.config.RuntimeBeanReference;
 import org.springframework.beans.factory.support.BeanDefinitionBuilder;
 import org.springframework.beans.factory.support.BeanDefinitionRegistry;
 import org.springframework.beans.factory.support.BeanDefinitionRegistryPostProcessor;
@@ -67,6 +68,7 @@ public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) {
 				registry.registerBeanDefinition(groupConfig.getGroup(), BeanDefinitionBuilder
 						.genericBeanDefinition(SpringdocBeanFactoryConfigurer.class)
 						.setFactoryMethod("groupedOpenApisFactoryMethod")
+						.addConstructorArgValue(new RuntimeBeanReference(GroupedOpenApi.Builder.class))
 						.addConstructorArgValue(groupConfig)
 						.getBeanDefinition())
 			);
@@ -81,12 +83,12 @@ public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)
 	/**
 	 * {@link GroupedOpenApi} factory method from {@link GroupConfig}.
 	 *
+	 * @param builder the {@link GroupedOpenApi.Builder}
 	 * @param groupConfig the {@link GroupConfig}
 	 * 
 	 * @return the {@link GroupedOpenApi}
 	 */
-	public static GroupedOpenApi groupedOpenApisFactoryMethod(GroupConfig groupConfig) {
-		GroupedOpenApi.Builder builder = GroupedOpenApi.builder();
+	public static GroupedOpenApi groupedOpenApisFactoryMethod(GroupedOpenApi.Builder builder, GroupConfig groupConfig) {
 		if (!CollectionUtils.isEmpty(groupConfig.getPackagesToScan()))
 			builder.packagesToScan(groupConfig.getPackagesToScan().toArray(new String[0]));
 		if (!CollectionUtils.isEmpty(groupConfig.getPathsToMatch()))

springdoc-openapi-common/src/main/java/org/springdoc/core/customizers/GlobalOpenApiCustomiser.java

@@ -0,0 +1,32 @@
+/*
+ *
+ *  *
+ *  *  * Copyright 2019-2022 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 org.springdoc.core.customizers;
+
+/**
+ * Implement and register a bean of type {@link GlobalOpenApiCustomiser} to
+ * customize Open api on default OpenAPI description and groups.
+ * 
+ * @author christophejan
+ * @see OpenApiCustomiser to customize default OpenAPI description but not
+ *      groups
+ */
+public interface GlobalOpenApiCustomiser extends OpenApiCustomiser {
+}

springdoc-openapi-common/src/main/java/org/springdoc/core/customizers/GlobalOperationCustomizer.java

@@ -0,0 +1,33 @@
+/*
+ *
+ *  *
+ *  *  * Copyright 2019-2022 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 org.springdoc.core.customizers;
+
+/**
+ * Implement and register a bean of type {@link GlobalOperationCustomizer} to
+ * customize an operation based on the handler method input on default OpenAPI
+ * description and groups
+ * 
+ * @author christophejan
+ * @see OperationCustomizer to customize operations on default OpenAPI
+ *      description but not groups
+ */
+public interface GlobalOperationCustomizer extends OperationCustomizer {
+}

springdoc-openapi-common/src/main/java/org/springdoc/core/customizers/OpenApiCustomiser.java

@@ -1,7 +1,7 @@
 /*
  *
  *  *
- *  *  * Copyright 2019-2020 the original author or authors.
+ *  *  * Copyright 2019-2022 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.
@@ -23,8 +23,12 @@
 import io.swagger.v3.oas.models.OpenAPI;
 
 /**
- * The interface Open api customiser.
+ * Implement and register a bean of type {@link OpenApiCustomiser} to customize
+ * Open api on default OpenAPI description but not on groups
+ * 
  * @author bnasslahsen
+ * @see GlobalOpenApiCustomiser to customize default OpenAPI description and
+ *      groups
  */
 @FunctionalInterface
 public interface OpenApiCustomiser {

springdoc-openapi-common/src/main/java/org/springdoc/core/customizers/OperationCustomizer.java

@@ -1,7 +1,7 @@
 /*
  *
  *  *
- *  *  * Copyright 2019-2020 the original author or authors.
+ *  *  * Copyright 2019-2022 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.
@@ -26,8 +26,12 @@
 
 /**
  * Implement and register a bean of type {@link OperationCustomizer} to customize an operation
- * based on the handler method input
+ * based on the handler method input on default OpenAPI descriptions but not
+ * groups
+ * 
  * @author bnasslahsen
+ * @see GlobalOperationCustomizer to customize operations on default OpenAPI
+ *      description and groups
  */
 @FunctionalInterface
 public interface OperationCustomizer {

springdoc-openapi-common/src/main/java/org/springdoc/core/filters/GlobalOpenApiMethodFilter.java

@@ -0,0 +1,34 @@
+/*
+ *
+ *  *
+ *  *  * Copyright 2019-2022 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 org.springdoc.core.filters;
+
+/**
+ * Implement and register a bean of type {@link GlobalOpenApiMethodFilter} to
+ * conditionally including any detected methods in default OpenAPI description
+ * and groups.
+ * 
+ * @author michael.clarke
+ * @see OpenApiMethodFilter to filter methods in default OpenAPI description but
+ *      not groups
+ */
+@FunctionalInterface
+public interface GlobalOpenApiMethodFilter extends OpenApiMethodFilter {
+}

springdoc-openapi-common/src/main/java/org/springdoc/core/filters/OpenApiMethodFilter.java

@@ -1,7 +1,7 @@
 /*
  *
  *  *
- *  *  * Copyright 2019-2020 the original author or authors.
+ *  *  * Copyright 2019-2022 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.
@@ -23,8 +23,13 @@
 import java.lang.reflect.Method;
 
 /**
- * A filter to allow conditionally including any detected methods in an OpenApi definition.
+ * Implement and register a bean of type {@link OpenApiMethodFilter} to
+ * conditionally include any detected methods in default OpenAPI descriptions
+ * but not groups
+ * 
  * @author michael.clarke
+ * @see GlobalOpenApiMethodFilter to filter methods in default OpenAPI
+ *      description and groups
  */
 @FunctionalInterface
 public interface OpenApiMethodFilter {

springdoc-openapi-webflux-core/src/test/java/test/org/springdoc/api/app184/HelloController.java

@@ -0,0 +1,53 @@
+/*
+ *
+ *  * Copyright 2019-2022 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.app184;
+
+
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+public class HelloController {
+
+	@GetMapping("/globalBeanFiltered")
+	public String globalBeanFiltered() {
+		return "globalBeanFiltered";
+	}
+
+	@GetMapping("/beanFiltered")
+	public String beanFiltered() {
+		return "beanFiltered";
+	}
+
+	@GetMapping("/group1Filtered")
+	public String group1Filtered() {
+		return "group1Filtered";
+	}
+
+	@GetMapping("/group2Filtered")
+	public String group2Filtered() {
+		return "group2Filtered";
+	}
+
+	@GetMapping("/group3Filtered")
+	public String group3Filtered() {
+		return "group3Filtered";
+	}
+
+}