Exposing swagger-ui on the management port. Fixes #923.

Author: bnasslahsen

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

@@ -237,7 +237,7 @@ public Operation build(HandlerMethod handlerMethod, RequestMethod requestMethod,
 
 		for (MethodParameter methodParameter : parameters) {
 			// check if query param
-			Parameter parameter = null;
+			Parameter parameter;
 			io.swagger.v3.oas.annotations.Parameter parameterDoc = AnnotatedElementUtils.findMergedAnnotation(
 					AnnotatedElementUtils.forAnnotations(methodParameter.getParameterAnnotations()),
 					io.swagger.v3.oas.annotations.Parameter.class);

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

@@ -114,7 +114,7 @@ else if ("application:management".equals(event.getApplicationContext().getId()))
 	 *
 	 * @return the tag
 	 */
-	public Tag getTag() {
+	public static Tag getTag() {
 		Tag actuatorTag = new Tag();
 		actuatorTag.setName(Constants.SPRINGDOC_ACTUATOR_TAG);
 		actuatorTag.setDescription(Constants.SPRINGDOC_ACTUATOR_DESCRIPTION);

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

@@ -318,7 +318,7 @@ public final class Constants {
 	/**
 	 * The constant DEFAULT_SWAGGER_UI_ACTUATOR_PATH.
 	 */
-	public static final String DEFAULT_SWAGGER_UI_ACTUATOR_PATH= "swagger-ui";
+	public static final String DEFAULT_SWAGGER_UI_ACTUATOR_PATH= "swaggerui";
 
 	/**
 	 * The constant DEFAULT_API_DOCS_ACTUATOR_URL.

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

@@ -41,13 +41,17 @@
 import org.springdoc.core.converters.PropertyCustomizingConverter;
 import org.springdoc.core.converters.ResponseSupportConverter;
 import org.springdoc.core.converters.SchemaPropertyDeprecatingConverter;
+import org.springdoc.core.customizers.ActuatorOpenApiCustomizer;
+import org.springdoc.core.customizers.ActuatorOperationCustomizer;
 import org.springdoc.core.customizers.DelegatingMethodParameterCustomizer;
 import org.springdoc.core.customizers.OpenApiBuilderCustomizer;
 import org.springdoc.core.customizers.OpenApiCustomiser;
+import org.springdoc.core.customizers.OperationCustomizer;
 import org.springdoc.core.customizers.PropertyCustomizer;
 
 import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
 import org.springframework.beans.factory.config.ConfigurableBeanFactory;
+import org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingClass;
@@ -70,6 +74,7 @@
 import static org.springdoc.core.Constants.SPRINGDOC_DEPRECATING_CONVERTER_ENABLED;
 import static org.springdoc.core.Constants.SPRINGDOC_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.SpringDocUtils.getConfig;
 
 /**
@@ -347,4 +352,35 @@ public ResponseEntity<ErrorMessage> handleNoHandlerFound(OpenApiResourceNotFound
 		}
 	}
 
+	/**
+	 * The type Spring doc web mvc actuator configuration.
+	 * @author bnasslashen
+	 */
+	@ConditionalOnClass(WebEndpointProperties.class)
+	@ConditionalOnProperty(SPRINGDOC_SHOW_ACTUATOR)
+	static class SpringDocWebMvcActuatorConfiguration {
+
+		/**
+		 * Actuator customizer operation customizer.
+		 *
+		 * @return the operation customizer
+		 */
+		@Bean
+		@Lazy(false)
+		OperationCustomizer actuatorCustomizer() {
+			return new ActuatorOperationCustomizer();
+		}
+
+		/**
+		 * Actuator customizer OpenAPI customiser.
+		 *
+		 * @return the OpenAPI customiser
+		 */
+		@Bean
+		@Lazy(false)
+		OpenApiCustomiser actuatorOpenApiCustomiser(WebEndpointProperties webEndpointProperties) {
+			return new ActuatorOpenApiCustomizer(webEndpointProperties);
+		}
+
+	}
 }

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

@@ -26,6 +26,9 @@
 import java.util.ArrayList;
 import java.util.List;
 
+import org.springdoc.core.customizers.ActuatorOpenApiCustomizer;
+import org.springdoc.core.customizers.ActuatorOperationCustomizer;
+
 import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
 import org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties;
 import org.springframework.boot.context.properties.bind.BindResult;
@@ -69,6 +72,8 @@ public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)
 			GroupedOpenApi actuatorGroup = GroupedOpenApi.builder().group(ACTUATOR_DEFAULT_GROUP)
 					.pathsToMatch(webEndpointProperties.getBasePath() + ALL_PATTERN)
 					.pathsToExclude(webEndpointProperties.getBasePath() + HEALTH_PATTERN)
+					.addOperationCustomizer(new ActuatorOperationCustomizer())
+					.addOpenApiCustomiser(new ActuatorOpenApiCustomizer(webEndpointProperties))
 					.build();
 			// Add the actuator group
 			newGroups.add(actuatorGroup);

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

@@ -11,8 +11,11 @@
 import io.swagger.v3.oas.models.parameters.Parameter;
 import io.swagger.v3.oas.models.parameters.PathParameter;
 
+import org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties;
 import org.springframework.util.CollectionUtils;
 
+import static org.springframework.util.AntPathMatcher.DEFAULT_PATH_SEPARATOR;
+
 /**
  * The type Actuator open api customiser.
  * @author bnasslahsen
@@ -24,10 +27,16 @@ public class ActuatorOpenApiCustomizer implements OpenApiCustomiser {
 	 */
 	private final Pattern pathPathern = Pattern.compile("\\{(.*?)}");
 
+	private WebEndpointProperties webEndpointProperties;
+
+	public ActuatorOpenApiCustomizer(WebEndpointProperties webEndpointProperties) {
+		this.webEndpointProperties = webEndpointProperties;
+	}
+
 	@Override
 	public void customise(OpenAPI openApi) {
 		openApi.getPaths().entrySet().stream()
-				.filter(stringPathItemEntry -> stringPathItemEntry.getKey().startsWith("/actuator/"))
+				.filter(stringPathItemEntry -> stringPathItemEntry.getKey().startsWith(webEndpointProperties.getBasePath()+DEFAULT_PATH_SEPARATOR))
 				.forEach(stringPathItemEntry -> {
 					String path = stringPathItemEntry.getKey();
 					Matcher matcher = pathPathern.matcher(path);

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

@@ -24,39 +24,29 @@
 package org.springdoc.core.customizers;
 
 import io.swagger.v3.oas.models.Operation;
-import org.springdoc.core.ActuatorProvider;
 
 import org.springframework.web.method.HandlerMethod;
 
+import static org.springdoc.core.ActuatorProvider.getTag;
+
 /**
  * The type Actuator operation customizer.
  * @author bnasslahsen
  */
 public class ActuatorOperationCustomizer implements OperationCustomizer {
 
-	/**
-	 * The Actuator provider.
-	 */
-	private final ActuatorProvider actuatorProvider;
-
 	/**
 	 * The Method count.
 	 */
 	private int methodCount;
 
-	/**
-	 * Instantiates a new Actuator operation customizer.
-	 *
-	 * @param actuatorProvider the actuator provider
-	 */
-	public ActuatorOperationCustomizer(ActuatorProvider actuatorProvider) {
-		this.actuatorProvider = actuatorProvider;
-	}
 
 	@Override
 	public Operation customize(Operation operation, HandlerMethod handlerMethod) {
-		if (operation.getTags() != null && operation.getTags().contains(actuatorProvider.getTag().getName())) {
-			operation.setSummary(handlerMethod.toString());
+		if (operation.getTags() != null && operation.getTags().contains(getTag().getName())) {
+			String summary = handlerMethod.toString();
+			if (!summary.contains("$"))
+				operation.setSummary(summary);
 			operation.setOperationId(operation.getOperationId() + "_" + methodCount++);
 		}
 		return operation;

springdoc-openapi-ui/src/test/java/test/org/springdoc/ui/app13/SpringDocApp13Test.java

@@ -48,13 +48,13 @@ void testIndex() throws Exception {
 
 	@Test
 	public void testIndexActuator() {
-		String contentAsString = actuatorRestTemplate.getForObject("/application/swagger-ui", String.class);
+		String contentAsString = actuatorRestTemplate.getForObject("/application/swaggerui", String.class);
 		assertTrue(contentAsString.contains("Swagger UI"));
 	}
 
 	@Test
 	public void testIndexSwaggerConfig() throws Exception {
-		String contentAsString = actuatorRestTemplate.getForObject("/application/swagger-ui/swagger-config", String.class);
+		String contentAsString = actuatorRestTemplate.getForObject("/application/swaggerui/swagger-config", String.class);
 		String expected = getContent("results/app13-1.json");
 		assertEquals(expected, contentAsString, true);
 	}

springdoc-openapi-ui/src/test/java/test/org/springdoc/ui/app14/SpringDocApp14Test.java

@@ -48,13 +48,13 @@ void testIndex() throws Exception {
 
 	@Test
 	public void testIndexActuator() {
-		String contentAsString = actuatorRestTemplate.getForObject("/application/swagger-ui", String.class);
+		String contentAsString = actuatorRestTemplate.getForObject("/application/swaggerui", String.class);
 		assertTrue(contentAsString.contains("Swagger UI"));
 	}
 
 	@Test
 	public void testIndexSwaggerConfig() throws Exception {
-		String contentAsString = actuatorRestTemplate.getForObject("/application/swagger-ui/swagger-config", String.class);
+		String contentAsString = actuatorRestTemplate.getForObject("/application/swaggerui/swagger-config", String.class);
 		String expected = getContent("results/app14-1.json");
 		assertEquals(expected, contentAsString, true);
 	}

springdoc-openapi-ui/src/test/java/test/org/springdoc/ui/app15/SpringDocApp15Test.java

@@ -51,13 +51,13 @@ void testIndex() throws Exception {
 
 	@Test
 	public void testIndexActuator() {
-		String contentAsString = actuatorRestTemplate.getForObject("/test/application/swagger-ui", String.class);
+		String contentAsString = actuatorRestTemplate.getForObject("/test/application/swaggerui", String.class);
 		assertTrue(contentAsString.contains("Swagger UI"));
 	}
 
 	@Test
 	public void testIndexSwaggerConfig() throws Exception {
-		String contentAsString = actuatorRestTemplate.getForObject("/test/application/swagger-ui/swagger-config", String.class);
+		String contentAsString = actuatorRestTemplate.getForObject("/test/application/swaggerui/swagger-config", String.class);
 		String expected = getContent("results/app15-1.json");
 		assertEquals(expected, contentAsString, true);
 	}