improving actuator docs

Author: bnasslahsen

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

@@ -49,6 +49,8 @@
 import java.util.concurrent.Executors;
 import java.util.concurrent.locks.Lock;
 import java.util.concurrent.locks.ReentrantLock;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
 import java.util.stream.Collectors;
 
 import com.fasterxml.jackson.annotation.JsonView;
@@ -213,6 +215,12 @@ public abstract class AbstractOpenApiResource extends SpecFilter {
 	 */
 	private final Lock reentrantLock = new ReentrantLock();
 
+	/**
+	 * The Path pattern.
+	 */
+	private final Pattern pathPattern = Pattern.compile("\\{(.*?)}");
+
+
 	/**
 	 * Instantiates a new Abstract open api resource.
 	 *
@@ -626,7 +634,18 @@ protected void calculatePath(HandlerMethod handlerMethod, RouterOperation router
 			operation = customizeOperation(operation, handlerMethod);
 
 			PathItem pathItemObject = buildPathItem(requestMethod, operation, operationPath, paths);
-			paths.addPathItem(operationPath, pathItemObject);
+
+			if (!StringUtils.contains(operationPath, "**")) {
+				if(StringUtils.contains(operationPath,"*")){
+					Matcher matcher = pathPattern.matcher(operationPath);
+					while (matcher.find()) {
+						String pathParam = matcher.group(1);
+						String newPathParam = pathParam.replace("*", "");
+						operationPath = operationPath.replace("{" + pathParam + "}", "{" + newPathParam + "}");
+					}
+				}
+				paths.addPathItem(operationPath, pathItemObject);
+			}
 		}
 	}
 
@@ -751,9 +770,9 @@ protected void calculatePath(RouterOperation routerOperation, Locale locale, Ope
 	 * @return the router operation
 	 */
 	private RouterOperation customizeDataRestRouterOperation(RouterOperation routerOperation) {
-		Optional<List<DataRestRouterOperationCustomizer>> optionalDataRestRouterOperationCustomizers = springDocCustomizers.getDataRestRouterOperationCustomizers();
+		Optional<Set<DataRestRouterOperationCustomizer>> optionalDataRestRouterOperationCustomizers = springDocCustomizers.getDataRestRouterOperationCustomizers();
 		if (optionalDataRestRouterOperationCustomizers.isPresent()) {
-			List<DataRestRouterOperationCustomizer> dataRestRouterOperationCustomizerList = optionalDataRestRouterOperationCustomizers.get();
+			Set<DataRestRouterOperationCustomizer> dataRestRouterOperationCustomizerList = optionalDataRestRouterOperationCustomizers.get();
 			for (DataRestRouterOperationCustomizer dataRestRouterOperationCustomizer : dataRestRouterOperationCustomizerList) {
 				routerOperation = dataRestRouterOperationCustomizer.customize(routerOperation);
 			}
@@ -977,9 +996,9 @@ protected Set<RequestMethod> getDefaultAllowedHttpMethods() {
 	 * @return the operation
 	 */
 	protected Operation customizeOperation(Operation operation, HandlerMethod handlerMethod) {
-		Optional<List<OperationCustomizer>> optionalOperationCustomizers = springDocCustomizers.getOperationCustomizers();
+		Optional<Set<OperationCustomizer>> optionalOperationCustomizers = springDocCustomizers.getOperationCustomizers();
 		if (optionalOperationCustomizers.isPresent()) {
-			List<OperationCustomizer> operationCustomizerList = optionalOperationCustomizers.get();
+			Set<OperationCustomizer> operationCustomizerList = optionalOperationCustomizers.get();
 			for (OperationCustomizer operationCustomizer : operationCustomizerList)
 				operation = operationCustomizer.customize(operation, handlerMethod);
 		}
@@ -994,9 +1013,9 @@ protected Operation customizeOperation(Operation operation, HandlerMethod handle
 	 * @return the router operation
 	 */
 	protected RouterOperation customizeRouterOperation(RouterOperation routerOperation, HandlerMethod handlerMethod) {
-		Optional<List<RouterOperationCustomizer>> optionalRouterOperationCustomizers = springDocCustomizers.getRouterOperationCustomizers();
+		Optional<Set<RouterOperationCustomizer>> optionalRouterOperationCustomizers = springDocCustomizers.getRouterOperationCustomizers();
 		if (optionalRouterOperationCustomizers.isPresent()) {
-			List<RouterOperationCustomizer> routerOperationCustomizerList = optionalRouterOperationCustomizers.get();
+			Set<RouterOperationCustomizer> routerOperationCustomizerList = optionalRouterOperationCustomizers.get();
 			for (RouterOperationCustomizer routerOperationCustomizer : routerOperationCustomizerList) {
 				routerOperation = routerOperationCustomizer.customize(routerOperation, handlerMethod);
 			}

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

@@ -31,6 +31,7 @@
 import java.util.Locale;
 import java.util.Map;
 import java.util.Optional;
+import java.util.Set;
 
 import com.fasterxml.jackson.databind.node.ObjectNode;
 import com.querydsl.core.types.Predicate;
@@ -54,7 +55,6 @@
 import org.springdoc.core.converters.ResponseSupportConverter;
 import org.springdoc.core.converters.SchemaPropertyDeprecatingConverter;
 import org.springdoc.core.converters.WebFluxSupportConverter;
-import org.springdoc.core.customizers.ActuatorOpenApiCustomizer;
 import org.springdoc.core.customizers.ActuatorOperationCustomizer;
 import org.springdoc.core.customizers.DataRestRouterOperationCustomizer;
 import org.springdoc.core.customizers.DelegatingMethodParameterCustomizer;
@@ -483,19 +483,6 @@ GlobalOperationCustomizer actuatorCustomizer(SpringDocConfigProperties springDoc
 			return new ActuatorOperationCustomizer(springDocConfigProperties);
 		}
 
-		/**
-		 * Actuator customizer OpenAPI customiser.
-		 *
-		 * @param webEndpointProperties the web endpoint properties
-		 * @return the OpenAPI customiser
-		 */
-		@Bean
-		@Lazy(false)
-		@ConditionalOnManagementPort(ManagementPortType.SAME)
-		GlobalOpenApiCustomizer actuatorOpenApiCustomizer(WebEndpointProperties webEndpointProperties) {
-			return new ActuatorOpenApiCustomizer(webEndpointProperties);
-		}
-
 	}
 
 	/**
@@ -612,12 +599,13 @@ public ResponseEntity<ErrorMessage> handleNoHandlerFound(OpenApiResourceNotFound
 	@Bean
 	@ConditionalOnMissingBean
 	@Lazy(false)
-	public SpringDocCustomizers springDocCustomizers(Optional<List<OpenApiCustomizer>> openApiCustomizers,
-			Optional<List<OperationCustomizer>> operationCustomizers,
-			Optional<List<RouterOperationCustomizer>> routerOperationCustomizers,
-			Optional<List<DataRestRouterOperationCustomizer>> dataRestRouterOperationCustomizers,
-			Optional<List<OpenApiMethodFilter>> methodFilters, Optional<List<GlobalOpenApiCustomizer>> globalOpenApiCustomizers, Optional<List<GlobalOperationCustomizer>> globalOperationCustomizers,
-			Optional<List<GlobalOpenApiMethodFilter>> globalOpenApiMethodFilters){
+	public SpringDocCustomizers springDocCustomizers(Optional<Set<OpenApiCustomizer>> openApiCustomizers,
+			Optional<Set<OperationCustomizer>> operationCustomizers,
+			Optional<Set<RouterOperationCustomizer>> routerOperationCustomizers,
+			Optional<Set<DataRestRouterOperationCustomizer>> dataRestRouterOperationCustomizers,
+			Optional<Set<OpenApiMethodFilter>> methodFilters, Optional<Set<GlobalOpenApiCustomizer>> globalOpenApiCustomizers, 
+			Optional<Set<GlobalOperationCustomizer>> globalOperationCustomizers,
+			Optional<Set<GlobalOpenApiMethodFilter>> globalOpenApiMethodFilters){
 		return new SpringDocCustomizers(openApiCustomizers,
 				operationCustomizers,
 				 routerOperationCustomizers,

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/configuration/SpringDocKotlinConfiguration.kt

@@ -1,7 +1,6 @@
 package org.springdoc.core.configuration
 
 import io.swagger.v3.oas.annotations.Parameter
-import io.swagger.v3.oas.models.media.ByteArraySchema
 import org.springdoc.core.customizers.ParameterCustomizer
 import org.springdoc.core.parsers.KotlinCoroutinesReturnTypeParser
 import org.springdoc.core.utils.Constants

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/configuration/SpringDocPageableConfiguration.java

@@ -29,7 +29,6 @@
 import org.springdoc.core.converters.PageOpenAPIConverter;
 import org.springdoc.core.converters.PageableOpenAPIConverter;
 import org.springdoc.core.customizers.DataRestDelegatingMethodParameterCustomizer;
-import org.springdoc.core.customizers.DelegatingMethodParameterCustomizer;
 import org.springdoc.core.providers.ObjectMapperProvider;
 import org.springdoc.core.providers.RepositoryRestConfigurationProvider;
 import org.springdoc.core.providers.SpringDataWebPropertiesProvider;

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/configuration/SpringDocSecurityOAuth2Customizer.java

@@ -4,8 +4,6 @@
 
 import io.swagger.v3.core.util.AnnotationsUtils;
 import io.swagger.v3.oas.annotations.enums.ParameterIn;
-import io.swagger.v3.oas.annotations.enums.SecuritySchemeType;
-import io.swagger.v3.oas.annotations.security.SecurityRequirements;
 import io.swagger.v3.oas.models.OpenAPI;
 import io.swagger.v3.oas.models.Operation;
 import io.swagger.v3.oas.models.PathItem;
@@ -24,10 +22,6 @@
 import io.swagger.v3.oas.models.parameters.RequestBody;
 import io.swagger.v3.oas.models.responses.ApiResponse;
 import io.swagger.v3.oas.models.responses.ApiResponses;
-import io.swagger.v3.oas.models.security.SecurityRequirement;
-import io.swagger.v3.oas.models.security.SecurityScheme;
-import io.swagger.v3.oas.models.security.SecurityScheme.In;
-import io.swagger.v3.oas.models.security.SecurityScheme.Type;
 import org.apache.commons.lang3.reflect.FieldUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/configuration/SpringDocSortConfiguration.java

@@ -29,7 +29,6 @@
 import org.springdoc.core.converters.SortOpenAPIConverter;
 import org.springdoc.core.converters.models.SortObject;
 import org.springdoc.core.customizers.DataRestDelegatingMethodParameterCustomizer;
-import org.springdoc.core.customizers.DelegatingMethodParameterCustomizer;
 import org.springdoc.core.providers.ObjectMapperProvider;
 import org.springdoc.core.providers.RepositoryRestConfigurationProvider;
 import org.springdoc.core.providers.SpringDataWebPropertiesProvider;

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

@@ -27,7 +27,6 @@
 import java.util.ArrayList;
 import java.util.List;
 
-import org.springdoc.core.customizers.ActuatorOpenApiCustomizer;
 import org.springdoc.core.customizers.ActuatorOperationCustomizer;
 import org.springdoc.core.models.GroupedOpenApi;
 import org.springdoc.core.properties.SpringDocConfigProperties;
@@ -76,9 +75,7 @@ public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)
 			WebEndpointProperties webEndpointProperties = result.get();
 			SpringDocConfigProperties springDocConfigProperties = springDocConfigPropertiesBindResult.get();
 			List<GroupedOpenApi> newGroups = new ArrayList<>();
-
-			ActuatorOpenApiCustomizer actuatorOpenApiCustomizer = new ActuatorOpenApiCustomizer(webEndpointProperties);
-			beanFactory.registerSingleton("actuatorOpenApiCustomizer", actuatorOpenApiCustomizer);
+			
 			ActuatorOperationCustomizer actuatorCustomizer = new ActuatorOperationCustomizer(springDocConfigProperties);
 			beanFactory.registerSingleton("actuatorCustomizer", actuatorCustomizer);