add SpringDocUtils.addHiddenRestControllers(String ...)

Author: bnasslahsen

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

@@ -138,6 +138,19 @@ public static void addHiddenRestControllers(Class<?>... classes) {
 		HIDDEN_REST_CONTROLLERS.addAll(Arrays.asList(classes));
 	}
 
+	public static void addHiddenRestControllers(String... classes) {
+		Set<Class<?>> hiddenClasses =new HashSet<>();
+		for (String aClass : classes) {
+			try {
+				hiddenClasses.add(Class.forName(aClass));
+			}
+			catch (ClassNotFoundException e) {
+				LOGGER.warn("The following class doesn't exist and cannot be hidden: "+ aClass);
+			}
+		}
+		HIDDEN_REST_CONTROLLERS.addAll(hiddenClasses);
+	}
+
 	protected synchronized OpenAPI getOpenApi() {
 		OpenAPI openApi;
 		if (openAPIBuilder.getCachedOpenAPI() == null || springDocConfigProperties.isCacheDisabled()) {
@@ -146,7 +159,7 @@ protected synchronized OpenAPI getOpenApi() {
 			Map<String, Object> mappingsMap = openAPIBuilder.getMappingsMap().entrySet().stream()
 					.filter(controller -> (AnnotationUtils.findAnnotation(controller.getValue().getClass(),
 							Hidden.class) == null))
-					.filter(controller -> !isHiddenRestControllers(controller.getValue().getClass()))
+					.filter(controller -> !AbstractOpenApiResource.isHiddenRestControllers(controller.getValue().getClass()))
 					.collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue, (a1, a2) -> a1));
 
 			Map<String, Object> findControllerAdvice = openAPIBuilder.getControllerAdviceMap();
@@ -425,7 +438,7 @@ protected boolean isAdditionalRestController(Class<?> rawClass) {
 		return ADDITIONAL_REST_CONTROLLERS.stream().anyMatch(clazz -> clazz.isAssignableFrom(rawClass));
 	}
 
-	protected boolean isHiddenRestControllers(Class<?> rawClass) {
+	public static boolean isHiddenRestControllers(Class<?> rawClass) {
 		return HIDDEN_REST_CONTROLLERS.stream().anyMatch(clazz -> clazz.isAssignableFrom(rawClass));
 	}
 

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

@@ -55,6 +55,11 @@ public SpringDocUtils addHiddenRestControllers(Class<?>... classes) {
 		return this;
 	}
 
+	public SpringDocUtils addHiddenRestControllers(String... classes) {
+		AbstractOpenApiResource.addHiddenRestControllers(classes);
+		return this;
+	}
+
 	public SpringDocUtils replaceWithClass(Class source, Class target) {
 		AdditionalModelsConverter.replaceWithClass(source, target);
 		return this;

springdoc-openapi-data-rest/src/main/java/org/springdoc/data/rest/SpringRepositoryRestResourceProvider.java

@@ -30,6 +30,7 @@
 import java.util.stream.Stream;
 
 import io.swagger.v3.oas.models.OpenAPI;
+import org.springdoc.api.AbstractOpenApiResource;
 import org.springdoc.core.RepositoryRestResourceProvider;
 import org.springdoc.core.fn.RouterOperation;
 import org.springdoc.data.rest.core.DataRestRouterOperationBuilder;
@@ -51,13 +52,13 @@
 
 public class SpringRepositoryRestResourceProvider implements RepositoryRestResourceProvider {
 
-	private static final String REPOSITORY_ENTITY_CONTROLLER = "org.springframework.data.rest.webmvc.RepositoryEntityController";
+	public static final String REPOSITORY_ENTITY_CONTROLLER = "org.springframework.data.rest.webmvc.RepositoryEntityController";
 
-	private static final String REPOSITORY_SERACH_CONTROLLER = "org.springframework.data.rest.webmvc.RepositorySearchController";
+	public static final String REPOSITORY_SERACH_CONTROLLER = "org.springframework.data.rest.webmvc.RepositorySearchController";
 
-	private static final String REPOSITORY_SCHEMA_CONTROLLER = "org.springframework.data.rest.webmvc.RepositorySchemaController";
+	public static final String REPOSITORY_SCHEMA_CONTROLLER = "org.springframework.data.rest.webmvc.RepositorySchemaController";
 
-	private static final String REPOSITORY_PROPERTY_CONTROLLER = "org.springframework.data.rest.webmvc.RepositoryPropertyReferenceController";
+	public static final String REPOSITORY_PROPERTY_CONTROLLER = "org.springframework.data.rest.webmvc.RepositoryPropertyReferenceController";
 
 	private ResourceMappings mappings;
 
@@ -93,6 +94,7 @@ public List<RouterOperation> getRouterOperations(OpenAPI openAPI) {
 								.filter(requestMappingInfoHandlerMethodEntry -> REPOSITORY_ENTITY_CONTROLLER.equals(requestMappingInfoHandlerMethodEntry
 										.getValue().getBeanType().getName()) || REPOSITORY_PROPERTY_CONTROLLER.equals(requestMappingInfoHandlerMethodEntry
 										.getValue().getBeanType().getName()))
+								.filter(controller -> !AbstractOpenApiResource.isHiddenRestControllers(controller.getValue().getBeanType()))
 								.collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue, (a1, a2) -> a1));
 						findControllers(routerOperationList, handlerMethodMapFiltered, resourceMetadata, domainType, openAPI);
 					}
@@ -102,6 +104,7 @@ else if (handlerMapping instanceof BasePathAwareHandlerMapping) {
 						Map<RequestMappingInfo, HandlerMethod> handlerMethodMapFiltered = handlerMethodMap.entrySet().stream()
 								.filter(requestMappingInfoHandlerMethodEntry -> REPOSITORY_SCHEMA_CONTROLLER.equals(requestMappingInfoHandlerMethodEntry
 										.getValue().getBeanType().getName()))
+								.filter(controller -> !AbstractOpenApiResource.isHiddenRestControllers(controller.getValue().getBeanType()))
 								.collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue, (a1, a2) -> a1));
 
 						findControllers(routerOperationList, handlerMethodMapFiltered, resourceMetadata, domainType, openAPI);
@@ -124,6 +127,7 @@ else if (handlerMapping instanceof BasePathAwareHandlerMapping) {
 					Map<RequestMappingInfo, HandlerMethod> handlerMethodMapFiltered = handlerMethodMap.entrySet().stream()
 							.filter(requestMappingInfoHandlerMethodEntry -> REPOSITORY_SERACH_CONTROLLER.equals(requestMappingInfoHandlerMethodEntry
 									.getValue().getBeanType().getName()))
+							.filter(controller -> !AbstractOpenApiResource.isHiddenRestControllers(controller.getValue().getBeanType()))
 							.collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue, (a1, a2) -> a1));
 					ResourceMetadata metadata = associations.getMetadataFor(domainType);
 					SearchResourceMappings searchResourceMappings = metadata.getSearchResourceMappings();