Merge branch 'valentinabojan-springdoc-data-rest-embedded-child-name'

Author: bnasslahsen

springdoc-openapi-data-rest/pom.xml

@@ -1,5 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+		 xmlns="http://maven.apache.org/POM/4.0.0"
+		 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 	<parent>
 		<artifactId>springdoc-openapi</artifactId>
 		<groupId>org.springdoc</groupId>

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

@@ -22,28 +22,30 @@
 
 import javax.annotation.PostConstruct;
 
-import io.swagger.v3.core.converter.ModelConverters;
 import io.swagger.v3.core.util.Json;
-import org.springdoc.data.rest.converters.CollectionModelContentConverter;
 
 import org.springframework.data.rest.core.config.RepositoryRestConfiguration;
 import org.springframework.hateoas.mediatype.hal.Jackson2HalModule;
 
 public class HalProvider {
 
-	private RepositoryRestConfiguration repositoryRestConfiguration;
+	private Optional<RepositoryRestConfiguration> repositoryRestConfigurationOptional;
 
-	public HalProvider(Optional<RepositoryRestConfiguration> optionalRepositoryRestConfiguration) {
-		optionalRepositoryRestConfiguration.ifPresent(repoRestConfiguration ->  this.repositoryRestConfiguration =repoRestConfiguration);
+	public HalProvider(Optional<RepositoryRestConfiguration> repositoryRestConfigurationOptional) {
+		this.repositoryRestConfigurationOptional = repositoryRestConfigurationOptional;
 	}
 
 	@PostConstruct
 	private void init() {
-		if (repositoryRestConfiguration == null || repositoryRestConfiguration.useHalAsDefaultJsonMediaType()) {
-			if (!Jackson2HalModule.isAlreadyRegisteredIn(Json.mapper()))
-				Json.mapper().registerModule(new Jackson2HalModule());
-			ModelConverters.getInstance()
-					.addConverter(CollectionModelContentConverter.getConverter());
-		}
+		if (!isHalEnabled())
+			return;
+		if (!Jackson2HalModule.isAlreadyRegisteredIn(Json.mapper()))
+			Json.mapper().registerModule(new Jackson2HalModule());
+	}
+
+	public boolean isHalEnabled() {
+		return repositoryRestConfigurationOptional
+				.map(RepositoryRestConfiguration::useHalAsDefaultJsonMediaType)
+				.orElse(true);
 	}
 }

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

@@ -31,6 +31,7 @@
 import io.swagger.v3.oas.models.media.ObjectSchema;
 import io.swagger.v3.oas.models.media.StringSchema;
 import org.springdoc.core.customizers.OpenApiCustomiser;
+import org.springdoc.data.rest.converters.CollectionModelContentConverter;
 import org.springdoc.data.rest.converters.Pageable;
 import org.springdoc.data.rest.converters.RepresentationModelLinksOASMixin;
 import org.springdoc.data.rest.customisers.QuerydslPredicateOperationCustomizer;
@@ -46,6 +47,7 @@
 import org.springframework.hateoas.Link;
 import org.springframework.hateoas.Links;
 import org.springframework.hateoas.RepresentationModel;
+import org.springframework.hateoas.server.LinkRelationProvider;
 
 import static org.springdoc.core.Constants.SPRINGDOC_ENABLED;
 import static org.springdoc.core.SpringDocUtils.getConfig;
@@ -82,6 +84,13 @@ HalProvider halProvider(Optional<RepositoryRestConfiguration> repositoryRestConf
 		return new HalProvider(repositoryRestConfiguration);
 	}
 
+	@Bean
+	@ConditionalOnMissingBean
+	@Lazy(false)
+	CollectionModelContentConverter collectionModelContentConverter(HalProvider halProvider, LinkRelationProvider linkRelationProvider) {
+		return halProvider.isHalEnabled() ? new CollectionModelContentConverter(linkRelationProvider) : null;
+	}
+
 	/**
 	 * Registers an OpenApiCustomiser and a jackson mixin to ensure the definition of `Links` matches the serialized
 	 * output. This is done because the customer serializer converts the data to a map before serializing it.
@@ -90,8 +99,8 @@ HalProvider halProvider(Optional<RepositoryRestConfiguration> repositoryRestConf
 	 */
 	@Bean
 	@Lazy(false)
-	OpenApiCustomiser linksSchemaCustomiser(Optional<RepositoryRestConfiguration> repositoryRestConfiguration) {
-		if (!repositoryRestConfiguration.isPresent() || !repositoryRestConfiguration.get().useHalAsDefaultJsonMediaType()) {
+	OpenApiCustomiser linksSchemaCustomiser(HalProvider halProvider) {
+		if (!halProvider.isHalEnabled()) {
 			return openApi -> {
 			};
 		}

springdoc-openapi-data-rest/src/main/java/org/springdoc/data/rest/converters/CollectionModelContentConverter.java

@@ -28,9 +28,10 @@
 import io.swagger.v3.core.converter.ModelConverter;
 import io.swagger.v3.core.converter.ModelConverterContext;
 import io.swagger.v3.oas.models.media.ArraySchema;
-import io.swagger.v3.oas.models.media.MapSchema;
+import io.swagger.v3.oas.models.media.ObjectSchema;
 import io.swagger.v3.oas.models.media.Schema;
-import io.swagger.v3.oas.models.media.StringSchema;
+import org.springframework.hateoas.EntityModel;
+import org.springframework.hateoas.server.LinkRelationProvider;
 
 /**
  * Override resolved schema as there is a custom serializer that converts the data to a map before serializing it.
@@ -40,13 +41,10 @@
  */
 public class CollectionModelContentConverter implements ModelConverter {
 
-	private static final CollectionModelContentConverter collectionModelContentConverter = new CollectionModelContentConverter();
+	private LinkRelationProvider linkRelationProvider;
 
-	private CollectionModelContentConverter() {
-	}
-
-	public static CollectionModelContentConverter getConverter() {
-		return collectionModelContentConverter;
+	public CollectionModelContentConverter(LinkRelationProvider linkRelationProvider) {
+		this.linkRelationProvider = linkRelationProvider;
 	}
 
 	@Override
@@ -55,12 +53,23 @@ public Schema<?> resolve(AnnotatedType type, ModelConverterContext context, Iter
 				&& "_embedded".equalsIgnoreCase(type.getPropertyName())) {
 			Schema<?> schema = chain.next().resolve(type, context, chain);
 			if (schema instanceof ArraySchema) {
-				return new MapSchema()
+				Class<?> entityType = getEntityType(type);
+				String entityClassName = linkRelationProvider.getCollectionResourceRelFor(entityType).value();
+
+				return new ObjectSchema()
 						.name("_embedded")
-						.additionalProperties(new StringSchema())
-						.additionalProperties(schema);
+						.addProperties(entityClassName, schema);
 			}
 		}
 		return chain.hasNext() ? chain.next().resolve(type, context, chain) : null;
 	}
+
+	private Class<?> getEntityType(AnnotatedType type) {
+		Class<?> containerEntityType = ((CollectionType) (type.getType())).getContentType().getRawClass();
+
+		if (containerEntityType.isAssignableFrom(EntityModel.class)) {
+			return ((CollectionType) type.getType()).getContentType().getBindings().getBoundType(0).getRawClass();
+		}
+		return containerEntityType;
+	}
 }

springdoc-openapi-data-rest/src/main/java/org/springdoc/data/rest/converters/Pageable.java

@@ -32,17 +32,17 @@
 public class Pageable {
 
 	@Min(0)
-	@Parameter(description = "Zero-based page index (0..N)",schema = @Schema(type = "integer", defaultValue = "0"))
+	@Parameter(description = "Zero-based page index (0..N)", schema = @Schema(type = "integer", defaultValue = "0"))
 	private Integer page;
 
 	@Min(1)
-	@Parameter(description = "The size of the page to be returned",schema = @Schema(type = "integer", defaultValue = "20"))
+	@Parameter(description = "The size of the page to be returned", schema = @Schema(type = "integer", defaultValue = "20"))
 	private Integer size;
 
 	@Parameter(description = "Sorting criteria in the format: property(,asc|desc). "
 			+ "Default sort order is ascending. " + "Multiple sort criteria are supported."
 			, name = "sort"
-			,array = @ArraySchema(schema = @Schema(type = "string")))
+			, array = @ArraySchema(schema = @Schema(type = "string")))
 	private List<String> sort;
 
 	public Pageable(int page, int size, List<String> sort) {
@@ -74,7 +74,8 @@ public List<String> getSort() {
 	public void setSort(List<String> sort) {
 		if (sort == null) {
 			this.sort.clear();
-		} else {
+		}
+		else {
 			this.sort = sort;
 		}
 	}

springdoc-openapi-data-rest/src/main/java/org/springdoc/data/rest/converters/PageableAsQueryParam.java

@@ -29,7 +29,7 @@
 import io.swagger.v3.oas.annotations.media.Content;
 import io.swagger.v3.oas.annotations.media.Schema;
 
-@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE})
+@Target({ ElementType.METHOD, ElementType.ANNOTATION_TYPE })
 @Retention(RetentionPolicy.RUNTIME)
 @Parameter(in = ParameterIn.QUERY
 		, description = "Zero-based page index (0..N)"

springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/AbstractSpringDocTest.java

@@ -22,15 +22,16 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
+import java.util.List;
 
+import io.swagger.v3.core.converter.ModelConverter;
 import io.swagger.v3.core.converter.ModelConverters;
 import nonapi.io.github.classgraph.utils.FileUtils;
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.Test;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springdoc.core.Constants;
-import org.springdoc.data.rest.converters.CollectionModelContentConverter;
 
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
@@ -54,6 +55,8 @@ public abstract class AbstractSpringDocTest {
 
 	public static String className;
 
+	private static List<ModelConverter> modelConverters;
+
 	@Autowired
 	protected MockMvc mockMvc;
 
@@ -70,10 +73,15 @@ public static String getContent(String fileName) throws Exception {
 
 	@AfterAll
 	public static void afterClass() {
-		ModelConverters.getInstance().removeConverter(CollectionModelContentConverter.getConverter());
+		modelConverters.forEach(ModelConverters.getInstance()::removeConverter);
 		System.clearProperty("spring.hateoas.use-hal-as-default-json-media-type");
 	}
 
+	@Autowired
+	private void setModelConverters(List<ModelConverter> modelConverters) {
+		AbstractSpringDocTest.modelConverters = modelConverters;
+	}
+
 	@Test
 	public void testApp() throws Exception {
 		className = getClass().getSimpleName();

springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app8/Album.java

@@ -2,26 +2,28 @@
 
 public class Album {
 
-    private String title;
-    private String description;
-    private String releaseDate;
-
-    public Album(String title, String description, String releaseDate) {
-        this.title = title;
-        this.description = description;
-        this.releaseDate = releaseDate;
-    }
-
-    public String getTitle() {
-        return title;
-    }
-
-    public String getDescription() {
-        return description;
-    }
-
-    public String getReleaseDate() {
-        return releaseDate;
-    }
+	private String title;
+
+	private String description;
+
+	private String releaseDate;
+
+	public Album(String title, String description, String releaseDate) {
+		this.title = title;
+		this.description = description;
+		this.releaseDate = releaseDate;
+	}
+
+	public String getTitle() {
+		return title;
+	}
+
+	public String getDescription() {
+		return description;
+	}
+
+	public String getReleaseDate() {
+		return releaseDate;
+	}
 
 }

springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app8/AlbumController.java

@@ -0,0 +1,31 @@
+package test.org.springdoc.api.app8;
+
+import java.util.Arrays;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.data.domain.Page;
+import org.springframework.data.domain.PageImpl;
+import org.springframework.data.web.PagedResourcesAssembler;
+import org.springframework.hateoas.PagedModel;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+public class AlbumController {
+
+	@Autowired
+	private AlbumModelAssembler albumModelAssembler;
+
+	@Autowired
+	private PagedResourcesAssembler pagedResourcesAssembler;
+
+	@GetMapping("/api/albums")
+	public PagedModel<Album> getAllAlbums() {
+		Album album1 = new Album("album-title-1", "album-description-1", "album-release-date-1");
+		Album album2 = new Album("album-title-2", "album-description-2", "album-release-date-2");
+		Page<Album> albumPage = new PageImpl<>(Arrays.asList(album1, album2));
+
+		return pagedResourcesAssembler.toModel(albumPage, albumModelAssembler);
+	}
+
+}

springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app8/AlbumModelAssembler.java

@@ -11,10 +11,10 @@
 @Component
 public class AlbumModelAssembler implements RepresentationModelAssembler<Album, EntityModel<Album>> {
 
-    @Override
-    public EntityModel<Album> toModel(Album entity) {
-        List<Link> links = new ArrayList<>();
-        return new EntityModel<>(entity, links);
-    }
+	@Override
+	public EntityModel<Album> toModel(Album entity) {
+		List<Link> links = new ArrayList<>();
+		return new EntityModel<>(entity, links);
+	}
 
 }

springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app8/WebController.java

@@ -15,6 +15,6 @@
 #  * limitations under the License.
 #  */
 #
-spring.main.banner-mode:"off"
+spring.main.banner-mode="off"
 logging.level.root=ERROR
 logging.level.test.org.springdoc.api=ERROR

springdoc-openapi-data-rest/src/test/resources/application-test.properties

@@ -130,10 +130,12 @@
         "properties": {
           "_embedded": {
             "type": "object",
-            "additionalProperties": {
-              "type": "array",
-              "items": {
-                "$ref": "#/components/schemas/EntityModelEmployee"
+            "properties": {
+              "employees": {
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/EntityModelEmployee"
+                }
               }
             }
           },