Spring Data Rest: Relations to exported Repositories are handled as if they were embedded. fixes #1084

Author: bnasslahsen

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

@@ -44,6 +44,7 @@
 import org.springdoc.data.rest.core.DataRestTagsService;
 import org.springdoc.data.rest.customisers.DataRestDelegatingMethodParameterCustomizer;
 import org.springdoc.data.rest.customisers.QuerydslPredicateOperationCustomizer;
+import org.springdoc.data.rest.utils.SpringDocDataRestUtils;
 
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
@@ -68,13 +69,14 @@
 import org.springframework.data.rest.webmvc.mapping.Associations;
 import org.springframework.data.rest.webmvc.support.DefaultedPageable;
 import org.springframework.data.rest.webmvc.support.ETag;
+import org.springframework.hateoas.server.LinkRelationProvider;
 
 import static org.springdoc.core.Constants.SPRINGDOC_ENABLED;
 import static org.springdoc.core.SpringDocUtils.getConfig;
 
 /**
  * The type Spring doc data rest configuration.
- * @author bnasslahsen
+ * @author bnasslashen
  */
 @Lazy(false)
 @Configuration(proxyBeanMethods = false)
@@ -97,7 +99,7 @@ public class SpringDocDataRestConfiguration {
 	@ConditionalOnMissingBean
 	@Lazy(false)
 	DelegatingMethodParameterCustomizer delegatingMethodParameterCustomizer(Optional<SpringDataWebProperties> optionalSpringDataWebProperties, Optional<RepositoryRestConfiguration> optionalRepositoryRestConfiguration) {
-		return new DataRestDelegatingMethodParameterCustomizer(optionalSpringDataWebProperties,optionalRepositoryRestConfiguration);
+		return new DataRestDelegatingMethodParameterCustomizer(optionalSpringDataWebProperties, optionalRepositoryRestConfiguration);
 	}
 
 	/**
@@ -111,14 +113,14 @@ DelegatingMethodParameterCustomizer delegatingMethodParameterCustomizer(Optional
 	@ConditionalOnMissingBean
 	@Primary
 	@Lazy(false)
-	DataRestHalProvider halProvider(Optional<RepositoryRestConfiguration> repositoryRestConfiguration,Optional<HateoasProperties> hateoasPropertiesOptional) {
-		return new DataRestHalProvider(repositoryRestConfiguration,hateoasPropertiesOptional);
+	DataRestHalProvider halProvider(Optional<RepositoryRestConfiguration> repositoryRestConfiguration, Optional<HateoasProperties> hateoasPropertiesOptional) {
+		return new DataRestHalProvider(repositoryRestConfiguration, hateoasPropertiesOptional);
 	}
 
 
 	/**
 	 * The type Querydsl provider.
-	 * @author bnasslahsen
+	 * @author bnasslashen
 	 */
 	@ConditionalOnClass(value = { QuerydslBindingsFactory.class })
 	class QuerydslProvider {
@@ -143,7 +145,7 @@ QuerydslPredicateOperationCustomizer queryDslQuerydslPredicateOperationCustomize
 
 	/**
 	 * The type Spring repository rest resource provider configuration.
-	 * @author bnasslahsen
+	 * @author bnasslashen
 	 */
 	@Lazy(false)
 	@Configuration(proxyBeanMethods = false)
@@ -163,7 +165,7 @@ static class SpringRepositoryRestResourceProviderConfiguration {
 		 * @param repositories the repositories
 		 * @param associations the associations
 		 * @param applicationContext the application context
-		 * @param dataRestRouterOperationService the data rest router operation builder
+		 * @param dataRestRouterOperationService the data rest router operation service
 		 * @param persistentEntities the persistent entities
 		 * @param mapper the mapper
 		 * @return the spring repository rest resource provider
@@ -174,18 +176,18 @@ SpringRepositoryRestResourceProvider springRepositoryRestResourceProvider(Resour
 				Repositories repositories, Associations associations, ApplicationContext applicationContext,
 				DataRestRouterOperationService dataRestRouterOperationService, PersistentEntities persistentEntities,
 				ObjectMapper mapper) {
-			return new SpringRepositoryRestResourceProvider(mappings,repositories,  associations,  applicationContext,
-					dataRestRouterOperationService,  persistentEntities, mapper);
+			return new SpringRepositoryRestResourceProvider(mappings, repositories, associations, applicationContext,
+					dataRestRouterOperationService, persistentEntities, mapper);
 		}
 
 		/**
-		 * Data rest router operation builder data rest router operation builder.
+		 * Data rest router operation builder data rest router operation service.
 		 *
-		 * @param dataRestOperationService the data rest operation builder
+		 * @param dataRestOperationService the data rest operation service
 		 * @param springDocConfigProperties the spring doc config properties
 		 * @param repositoryRestConfiguration the repository rest configuration
 		 * @param dataRestHalProvider the data rest hal provider
-		 * @return the data rest router operation builder
+		 * @return the data rest router operation service
 		 */
 		@Bean
 		@ConditionalOnMissingBean
@@ -207,7 +209,7 @@ DataRestRouterOperationService dataRestRouterOperationBuilder(DataRestOperationS
 		@ConditionalOnMissingBean
 		DataRestOperationService dataRestOperationBuilder(DataRestRequestService dataRestRequestService, DataRestTagsService tagsBuilder,
 				DataRestResponseService dataRestResponseService, OperationService operationService) {
-			return new DataRestOperationService(dataRestRequestService, tagsBuilder, dataRestResponseService,operationService);
+			return new DataRestOperationService(dataRestRequestService, tagsBuilder, dataRestResponseService, operationService);
 		}
 
 		/**
@@ -217,26 +219,28 @@ DataRestOperationService dataRestOperationBuilder(DataRestRequestService dataRes
 		 * @param parameterBuilder the parameter builder
 		 * @param requestBodyService the request body builder
 		 * @param requestBuilder the request builder
+		 * @param springDocDataRestUtils the spring doc data rest utils
 		 * @return the data rest request builder
 		 */
 		@Bean
 		@ConditionalOnMissingBean
 		DataRestRequestService dataRestRequestBuilder(LocalVariableTableParameterNameDiscoverer localSpringDocParameterNameDiscoverer, GenericParameterService parameterBuilder,
-				RequestBodyService requestBodyService, AbstractRequestService requestBuilder) {
+				RequestBodyService requestBodyService, AbstractRequestService requestBuilder,SpringDocDataRestUtils springDocDataRestUtils) {
 			return new DataRestRequestService(localSpringDocParameterNameDiscoverer, parameterBuilder,
-					requestBodyService, requestBuilder);
+					requestBodyService, requestBuilder, springDocDataRestUtils);
 		}
 
 		/**
 		 * Data rest response builder data rest response builder.
 		 *
 		 * @param genericResponseService the generic response builder
+		 * @param springDocDataRestUtils the spring doc data rest utils
 		 * @return the data rest response builder
 		 */
 		@Bean
 		@ConditionalOnMissingBean
-		DataRestResponseService dataRestResponseBuilder(GenericResponseService genericResponseService) {
-			return new DataRestResponseService(genericResponseService);
+		DataRestResponseService dataRestResponseBuilder(GenericResponseService genericResponseService, SpringDocDataRestUtils springDocDataRestUtils) {
+			return new DataRestResponseService(genericResponseService, springDocDataRestUtils);
 		}
 
 		/**
@@ -250,6 +254,18 @@ DataRestResponseService dataRestResponseBuilder(GenericResponseService genericRe
 		DataRestTagsService dataRestTagsBuilder(OpenAPIService openAPIService) {
 			return new DataRestTagsService(openAPIService);
 		}
+
+		/**
+		 * Spring doc data rest utils spring doc data rest utils.
+		 *
+		 * @param linkRelationProvider the link relation provider
+		 * @return the spring doc data rest utils
+		 */
+		@Bean
+		@ConditionalOnMissingBean
+		SpringDocDataRestUtils springDocDataRestUtils(LinkRelationProvider linkRelationProvider) {
+			return new SpringDocDataRestUtils(linkRelationProvider);
+		}
 	}
 
 }

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

@@ -181,6 +181,7 @@ public List<RouterOperation> getRouterOperations(OpenAPI openAPI) {
 			DataRestRepository dataRestRepository = new DataRestRepository(domainType, repository);
 			ResourceMetadata resourceMetadata = mappings.getMetadataFor(domainType);
 			final PersistentEntity<?, ?> entity = persistentEntities.getRequiredPersistentEntity(domainType);
+			dataRestRepository.setPersistentEntity(entity);
 			final JacksonMetadata jackson = new JacksonMetadata(mapper, domainType);
 
 			if (resourceMetadata.isExported()) {
@@ -339,7 +340,8 @@ private void findSearchResourceMappings(OpenAPI openAPI, List<RouterOperation> r
 	 * @return the list
 	 */
 	private List<RouterOperation> findSearchControllers(List<RouterOperation> routerOperationList,
-			Map<RequestMappingInfo, HandlerMethod> handlerMethodMap, ResourceMetadata resourceMetadata, DataRestRepository dataRestRepository, OpenAPI openAPI, SearchResourceMappings searchResourceMappings) {
+			Map<RequestMappingInfo, HandlerMethod> handlerMethodMap, ResourceMetadata resourceMetadata, DataRestRepository dataRestRepository,
+			OpenAPI openAPI, SearchResourceMappings searchResourceMappings) {
 		Stream<MethodResourceMapping> methodResourceMappingStream = searchResourceMappings.getExportedMappings();
 		methodResourceMappingStream.forEach(methodResourceMapping -> dataRestRouterOperationService.buildSearchRouterOperationList(
 				routerOperationList, handlerMethodMap, resourceMetadata, dataRestRepository, openAPI, methodResourceMapping));

springdoc-openapi-data-rest/src/main/java/org/springdoc/data/rest/core/DataRestOperationService.java

@@ -95,6 +95,7 @@ public class DataRestOperationService {
 	 * @param dataRestRequestService the data rest request builder
 	 * @param tagsBuilder the tags builder
 	 * @param dataRestResponseService the data rest response builder
+	 * @param operationService the operation service
 	 */
 	public DataRestOperationService(DataRestRequestService dataRestRequestService, DataRestTagsService tagsBuilder,
 			DataRestResponseService dataRestResponseService, OperationService operationService) {
@@ -130,7 +131,7 @@ public Operation buildOperation(HandlerMethod handlerMethod, DataRestRepository
 		}
 		else if (ControllerType.SEARCH.equals(controllerType)) {
 			operation = buildSearchOperation(handlerMethod, dataRestRepository, openAPI, requestMethod,
-					methodAttributes, methodResourceMapping);
+					methodAttributes, methodResourceMapping, resourceMetadata);
 		}
 		return operation;
 	}
@@ -154,7 +155,7 @@ private Operation buildEntityOperation(HandlerMethod handlerMethod, DataRestRepo
 		if (!ControllerType.GENERAL.equals(dataRestRepository.getControllerType()))
 			domainType = dataRestRepository.getDomainType();
 		Operation operation = initOperation(handlerMethod, domainType, requestMethod);
-		dataRestRequestService.buildParameters(domainType, openAPI, handlerMethod, requestMethod, methodAttributes, operation, resourceMetadata);
+		dataRestRequestService.buildParameters(openAPI, handlerMethod, requestMethod, methodAttributes, operation, resourceMetadata, dataRestRepository);
 		dataRestResponseService.buildEntityResponse(operation, handlerMethod, openAPI, requestMethod, operationPath, domainType, methodAttributes, dataRestRepository, resourceMetadata);
 		tagsBuilder.buildEntityTags(operation, handlerMethod, dataRestRepository);
 		if (domainType != null)
@@ -171,11 +172,12 @@ private Operation buildEntityOperation(HandlerMethod handlerMethod, DataRestRepo
 	 * @param requestMethod the request method
 	 * @param methodAttributes the method attributes
 	 * @param methodResourceMapping the method resource mapping
+	 * @param resourceMetadata the resource metadata
 	 * @return the operation
 	 */
 	private Operation buildSearchOperation(HandlerMethod handlerMethod, DataRestRepository dataRestRepository,
 			OpenAPI openAPI, RequestMethod requestMethod, MethodAttributes methodAttributes,
-			MethodResourceMapping methodResourceMapping) {
+			MethodResourceMapping methodResourceMapping, ResourceMetadata resourceMetadata) {
 		Class<?> domainType = dataRestRepository.getDomainType();
 		Operation operation = initOperation(handlerMethod, domainType, requestMethod);
 
@@ -193,7 +195,7 @@ private Operation buildSearchOperation(HandlerMethod handlerMethod, DataRestRepo
 			HandlerMethod repositoryHandlerMethod = new HandlerMethod(methodResourceMapping.getMethod().getDeclaringClass(), methodResourceMapping.getMethod());
 			MethodParameter[] parameters = repositoryHandlerMethod.getMethodParameters();
 			for (MethodParameter methodParameter : parameters) {
-				dataRestRequestService.buildCommonParameters(domainType, openAPI, requestMethod, methodAttributes, operation, new String[] { methodParameter.getParameterName() }, new MethodParameter[] { methodParameter });
+				dataRestRequestService.buildCommonParameters(openAPI, requestMethod, methodAttributes, operation, new String[] { methodParameter.getParameterName() }, new MethodParameter[] { methodParameter }, resourceMetadata, dataRestRepository);
 			}
 		}
 
@@ -222,9 +224,10 @@ private Operation buildSearchOperation(HandlerMethod handlerMethod, DataRestRepo
 		if (methodResourceMapping.isPagingResource()) {
 			MethodParameter[] parameters = handlerMethod.getMethodParameters();
 			Arrays.stream(parameters).filter(methodParameter -> DefaultedPageable.class.equals(methodParameter.getParameterType())).findAny()
-					.ifPresent(methodParameterPage -> dataRestRequestService.buildCommonParameters(domainType, openAPI, requestMethod, methodAttributes, operation, new String[] { methodParameterPage.getParameterName() }, new MethodParameter[] { methodParameterPage }));
+					.ifPresent(methodParameterPage -> dataRestRequestService.buildCommonParameters(openAPI, requestMethod, methodAttributes, operation,
+							new String[] { methodParameterPage.getParameterName() }, new MethodParameter[] { methodParameterPage }, resourceMetadata, dataRestRepository));
 		}
-		dataRestResponseService.buildSearchResponse(operation, handlerMethod, openAPI, methodResourceMapping, domainType, methodAttributes);
+		dataRestResponseService.buildSearchResponse(operation, handlerMethod, openAPI, methodResourceMapping, domainType, methodAttributes, resourceMetadata, dataRestRepository);
 		tagsBuilder.buildSearchTags(operation, handlerMethod, dataRestRepository, method);
 		return operation;
 	}
@@ -307,8 +310,10 @@ private void addOperationDescription(Operation operation, RequestMethod requestM
 	/**
 	 * Create description.
 	 *
+	 * @param action the action
 	 * @param entity the entity
 	 * @param dataRestRepository the data rest repository
+	 * @return the string
 	 */
 	private String createDescription( String action, String entity, DataRestRepository dataRestRepository) {
 		String description;

springdoc-openapi-data-rest/src/main/java/org/springdoc/data/rest/core/DataRestRepository.java

@@ -23,6 +23,8 @@
 
 package org.springdoc.data.rest.core;
 
+import org.springframework.data.mapping.PersistentEntity;
+
 /**
  * The type Data rest repository.
  * @author bnasslahsen
@@ -64,6 +66,11 @@ public class DataRestRepository {
 	 */
 	private Class<?> propertyType;
 
+	/**
+	 * The Persistent entity.
+	 */
+	PersistentEntity<?, ?> persistentEntity;
+
 	/**
 	 * Instantiates a new Data rest repository.
 	 *
@@ -81,7 +88,9 @@ public DataRestRepository(Class<?> domainType, Class<?> repositoryType) {
 	 * @return the domain type
 	 */
 	public Class<?> getDomainType() {
-		return domainType;
+		if (!ControllerType.GENERAL.equals(controllerType))
+			return domainType;
+		return null;
 	}
 
 	/**
@@ -200,4 +209,39 @@ public Class<?> getPropertyType() {
 	public void setPropertyType(Class<?> propertyType) {
 		this.propertyType = propertyType;
 	}
+
+	/**
+	 * Gets persistent entity.
+	 *
+	 * @return the persistent entity
+	 */
+	public PersistentEntity<?, ?> getPersistentEntity() {
+		return persistentEntity;
+	}
+
+	/**
+	 * Sets persistent entity.
+	 *
+	 * @param persistentEntity the persistent entity
+	 */
+	public void setPersistentEntity(PersistentEntity<?, ?> persistentEntity) {
+		this.persistentEntity = persistentEntity;
+	}
+
+	/**
+	 * Gets return type.
+	 *
+	 * @return the return type
+	 */
+	public Class getReturnType() {
+		Class returnedEntityType = domainType;
+
+		if (ControllerType.PROPERTY.equals(controllerType))
+			returnedEntityType = propertyType;
+
+		else if (ControllerType.GENERAL.equals(controllerType))
+			returnedEntityType = null;
+
+		return returnedEntityType;
+	}
 }