Merge branch 'christophejan-feature/global-customizer-and-filters'

Author: bnasslahsen

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

@@ -22,6 +22,8 @@
 
 import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.Collection;
+import java.util.Collections;
 import java.util.List;
 import java.util.Objects;
 
@@ -463,11 +465,38 @@ public GroupedOpenApi build() {
 	}
 
 	/**
-	 * Add open api customiser.
+	 * Add all open api customizer grouped open api.
 	 *
-	 * @param openApiCustomiser the open api customiser
+	 * @param openApiCustomizerCollection the open api customizer collection
+	 * @return the grouped open api
 	 */
-	public void addOpenApiCustomizer(OpenApiCustomiser openApiCustomiser) {
-		this.openApiCustomisers.add(openApiCustomiser);
+	public GroupedOpenApi addAllOpenApiCustomizer(Collection openApiCustomizerCollection) {
+		this.openApiCustomisers.addAll(openApiCustomizerCollection);
+		Collections.reverse(openApiCustomisers);
+		return this;
+	}
+
+	/**
+	 * Add all operation customizer grouped open api.
+	 *
+	 * @param operationCustomizerCollection the operation customizer collection
+	 * @return the grouped open api
+	 */
+	public GroupedOpenApi addAllOperationCustomizer(Collection operationCustomizerCollection) {
+		this.operationCustomizers.addAll(operationCustomizerCollection);
+		Collections.reverse(operationCustomizers);
+		return this;
+	}
+
+	/**
+	 * Add all open api method filter grouped open api.
+	 *
+	 * @param openApiMethodFilterCollection the open api method filter collection
+	 * @return the grouped open api
+	 */
+	public GroupedOpenApi addAllOpenApiMethodFilter(Collection openApiMethodFilterCollection) {
+		this.openApiMethodFilters.addAll(openApiMethodFilterCollection);
+		Collections.reverse(openApiMethodFilters);
+		return this;
 	}
 }

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

@@ -49,6 +49,7 @@
 import org.springdoc.core.customizers.ActuatorOperationCustomizer;
 import org.springdoc.core.customizers.DataRestDelegatingMethodParameterCustomizer;
 import org.springdoc.core.customizers.DelegatingMethodParameterCustomizer;
+import org.springdoc.core.customizers.GlobalOpenApiCustomizer;
 import org.springdoc.core.customizers.OpenApiBuilderCustomizer;
 import org.springdoc.core.customizers.OpenApiCustomiser;
 import org.springdoc.core.customizers.OperationCustomizer;
@@ -341,7 +342,7 @@ GenericParameterService parameterBuilder(PropertyResolverUtils propertyResolverU
 	@Bean
 	@ConditionalOnProperty(SPRINGDOC_SCHEMA_RESOLVE_PROPERTIES)
 	@Lazy(false)
-	OpenApiCustomiser propertiesResolverForSchema(PropertyResolverUtils propertyResolverUtils) {
+	GlobalOpenApiCustomizer propertiesResolverForSchema(PropertyResolverUtils propertyResolverUtils) {
 		return openApi -> {
 			Components components = openApi.getComponents();
 			Map<String, Schema> schemas = components.getSchemas();

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

@@ -27,6 +27,7 @@
 import java.util.stream.Collectors;
 
 import io.swagger.v3.oas.models.OpenAPI;
+import org.apache.commons.lang3.StringUtils;
 
 import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
 import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
@@ -70,6 +71,18 @@ public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)
 							builder.packagesToScan(elt.getPackagesToScan().toArray(new String[0]));
 						if (!CollectionUtils.isEmpty(elt.getPathsToMatch()))
 							builder.pathsToMatch(elt.getPathsToMatch().toArray(new String[0]));
+						if (!CollectionUtils.isEmpty(elt.getProducesToMatch()))
+							builder.producesToMatch(elt.getProducesToMatch().toArray(new String[0]));
+						if (!CollectionUtils.isEmpty(elt.getConsumesToMatch()))
+							builder.consumesToMatch(elt.getConsumesToMatch().toArray(new String[0]));
+						if (!CollectionUtils.isEmpty(elt.getHeadersToMatch()))
+							builder.headersToMatch(elt.getHeadersToMatch().toArray(new String[0]));
+						if (!CollectionUtils.isEmpty(elt.getPathsToExclude()))
+							builder.pathsToExclude(elt.getPathsToExclude().toArray(new String[0]));
+						if (!CollectionUtils.isEmpty(elt.getPackagesToExclude()))
+							builder.packagesToExclude(elt.getPackagesToExclude().toArray(new String[0]));
+						if (StringUtils.isNotEmpty(elt.getDisplayName()))
+							builder.displayName(elt.getDisplayName());
 						return builder.group(elt.getGroup()).build();
 					})
 					.collect(Collectors.toList());

springdoc-openapi-common/src/main/java/org/springdoc/core/customizers/GlobalOpenApiCustomizer.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 GlobalOpenApiCustomizer} to
+ * customize Open api on default OpenAPI description and groups.
+ * 
+ * @author christophejan
+ * @see OpenApiCustomiser to customize default OpenAPI description but not
+ *      groups
+ */
+public interface GlobalOpenApiCustomizer 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 GlobalOpenApiCustomizer 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/main/java/org/springdoc/webflux/api/MultipleOpenApiResource.java

@@ -34,7 +34,9 @@
 import org.springdoc.core.SpringDocConfigProperties;
 import org.springdoc.core.SpringDocConfigProperties.GroupConfig;
 import org.springdoc.core.SpringDocProviders;
-import org.springdoc.core.customizers.OpenApiCustomiser;
+import org.springdoc.core.customizers.GlobalOpenApiCustomizer;
+import org.springdoc.core.customizers.GlobalOperationCustomizer;
+import org.springdoc.core.filters.GlobalOpenApiMethodFilter;
 
 import org.springframework.beans.BeansException;
 import org.springframework.beans.factory.InitializingBean;
@@ -123,14 +125,20 @@ protected MultipleOpenApiResource(List<GroupedOpenApi> groupedOpenApis,
 
 	@Override
 	public void afterPropertiesSet() {
-		if (springDocConfigProperties.getApiDocs().isResolveSchemaProperties()) {
-			OpenApiCustomiser propertiesResolverForSchemaCustomizer = (OpenApiCustomiser) applicationContext.getBean("propertiesResolverForSchema");
-			this.groupedOpenApis.forEach(groupedOpenApi -> groupedOpenApi.addOpenApiCustomizer(propertiesResolverForSchemaCustomizer));
-		}
+		Map<String, GlobalOpenApiCustomizer> globalOpenApiCustomizerMap = applicationContext.getBeansOfType(GlobalOpenApiCustomizer.class);
+		Map<String, GlobalOperationCustomizer> globalOperationCustomizerMap = applicationContext.getBeansOfType(GlobalOperationCustomizer.class);
+		Map<String, GlobalOpenApiMethodFilter> globalOpenApiMethodFilterMap = applicationContext.getBeansOfType(GlobalOpenApiMethodFilter.class);
+
+		this.groupedOpenApis.forEach(groupedOpenApi -> groupedOpenApi
+				.addAllOpenApiCustomizer(globalOpenApiCustomizerMap.values())
+				.addAllOperationCustomizer(globalOperationCustomizerMap.values())
+				.addAllOpenApiMethodFilter(globalOpenApiMethodFilterMap.values())
+		);
+
 		this.groupedOpenApiResources = groupedOpenApis.stream()
 				.collect(Collectors.toMap(GroupedOpenApi::getGroup, item ->
 						{
-							GroupConfig groupConfig = new GroupConfig(item.getGroup(), item.getPathsToMatch(), item.getPackagesToScan(), item.getPackagesToExclude(), item.getPathsToExclude(), item.getProducesToMatch(), item.getConsumesToMatch(), item.getHeadersToMatch(),item.getDisplayName());
+							GroupConfig groupConfig = new GroupConfig(item.getGroup(), item.getPathsToMatch(), item.getPackagesToScan(), item.getPackagesToExclude(), item.getPathsToExclude(), item.getProducesToMatch(), item.getConsumesToMatch(), item.getHeadersToMatch(), item.getDisplayName());
 							springDocConfigProperties.addGroupConfig(groupConfig);
 							return buildWebFluxOpenApiResource(item);
 						}

springdoc-openapi-webflux-core/src/test/java/test/org/springdoc/api/app145/SpringDocApp145Test.java

@@ -1,6 +1,6 @@
 /*
  *
- *  * 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.
@@ -18,13 +18,18 @@
 
 package test.org.springdoc.api.app145;
 
+import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.junit.jupiter.api.Assertions.fail;
+
 import org.junit.jupiter.api.Test;
 import org.springdoc.core.Constants;
 import test.org.springdoc.api.AbstractSpringDocActuatorTest;
 
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
+import org.springframework.http.HttpStatus;
+import org.springframework.web.reactive.function.client.WebClientResponseException;
 
 
 @SpringBootTest(webEnvironment = WebEnvironment.DEFINED_PORT,
@@ -47,4 +52,19 @@ public void testApp()  {
 				.expectStatus().isNotFound();
 	}
 
+	@Test
+	public void testApp3() throws Exception {
+		try {
+			webClient.get().uri("/application/openapi"+  "/"+Constants.DEFAULT_GROUP_NAME).retrieve()
+					.bodyToMono(String.class).block();
+			fail();
+		}
+		catch (WebClientResponseException ex) {
+			if (ex.getStatusCode() == HttpStatus.NOT_FOUND)
+				assertTrue(true);
+			else
+				fail();
+		}
+	}
+
 }

springdoc-openapi-webflux-core/src/test/java/test/org/springdoc/api/app147/SpringDocApp147Test.java

@@ -68,4 +68,11 @@ public void testApp1() throws Exception {
 		assertEquals(expected, result, true);
 	}
 
+	@Test
+	public void testApp2() throws Exception {
+		webTestClient.get().uri(Constants.DEFAULT_API_DOCS_URL + "/"+Constants.DEFAULT_GROUP_NAME)
+				.exchange()
+				.expectStatus().isNotFound();
+	}
+
 }