Merge branch 'hal-collectionmodel-content-map' of https://github.com/fredrik-w/springdoc-openapi into fredrik-w-hal-collectionmodel-content-map

Author: bnasslahsen

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

@@ -20,8 +20,10 @@
 
 import javax.annotation.PostConstruct;
 
+import io.swagger.v3.core.converter.ModelConverters;
 import io.swagger.v3.core.util.Json;
 
+import org.springdoc.core.hal.CollectionModelContentConverter;
 import org.springframework.data.rest.core.config.RepositoryRestConfiguration;
 import org.springframework.hateoas.mediatype.hal.Jackson2HalModule;
 
@@ -35,7 +37,10 @@ public HalProvider(RepositoryRestConfiguration repositoryRestConfiguration) {
 
 	@PostConstruct
 	private void init(){
-		if(repositoryRestConfiguration.useHalAsDefaultJsonMediaType())
+		if(repositoryRestConfiguration.useHalAsDefaultJsonMediaType()) {
 			Json.mapper().registerModule(new Jackson2HalModule());
+			ModelConverters.getInstance()
+					.addConverter(new CollectionModelContentConverter());
+		}
 	}
 }

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

@@ -24,21 +24,20 @@
 import io.swagger.v3.core.converter.ModelConverters;
 import io.swagger.v3.core.converter.ResolvedSchema;
 import io.swagger.v3.core.util.Json;
-import io.swagger.v3.oas.annotations.media.Schema;
 import io.swagger.v3.oas.models.media.MapSchema;
 import io.swagger.v3.oas.models.media.ObjectSchema;
 import io.swagger.v3.oas.models.media.StringSchema;
 import org.springdoc.core.converters.Pageable;
 import org.springdoc.core.customizers.OpenApiCustomiser;
 
+import org.springdoc.core.hal.RepresentationModelLinksOASMixin;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.data.rest.core.config.RepositoryRestConfiguration;
 import org.springframework.hateoas.Link;
 import org.springframework.hateoas.Links;
 import org.springframework.hateoas.RepresentationModel;
-import org.springframework.hateoas.mediatype.hal.RepresentationModelMixin;
 
 import static org.springdoc.core.Constants.SPRINGDOC_ENABLED;
 import static org.springdoc.core.SpringDocUtils.getConfig;
@@ -69,18 +68,14 @@ public OpenApiCustomiser linksSchemaCustomiser(RepositoryRestConfiguration repos
             return openApi -> {};
         }
         Json.mapper().addMixIn(RepresentationModel.class, RepresentationModelLinksOASMixin.class);
+
         ResolvedSchema resolvedLinkSchema = ModelConverters.getInstance()
                 .resolveAsResolvedSchema(new AnnotatedType(Link.class));
+
         return openApi -> openApi
 				.schema("Link", resolvedLinkSchema.schema)
 				.schema("Links", new MapSchema()
 						.additionalProperties(new StringSchema())
 						.additionalProperties(new ObjectSchema().$ref("#/components/schemas/Link")));
     }
-
-	abstract static class RepresentationModelLinksOASMixin extends RepresentationModelMixin {
-        @Override
-        @Schema(ref = "#/components/schemas/Links")
-        public abstract Links getLinks();
-    }
 }

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

@@ -0,0 +1,38 @@
+package org.springdoc.core.hal;
+
+import com.fasterxml.jackson.core.JsonGenerator;
+import com.fasterxml.jackson.databind.SerializerProvider;
+import com.fasterxml.jackson.databind.type.CollectionType;
+import io.swagger.v3.core.converter.AnnotatedType;
+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.Schema;
+import io.swagger.v3.oas.models.media.StringSchema;
+
+import java.util.Collection;
+import java.util.Iterator;
+
+/**
+ * Override resolved schema as there is a custom serializer that converts the data to a map before serializing it.
+ *
+ * @see org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalResourcesSerializer
+ * @see org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalResourcesSerializer#serialize(Collection, JsonGenerator, SerializerProvider)
+ */
+public class CollectionModelContentConverter implements ModelConverter {
+    @Override
+    public Schema<?> resolve(AnnotatedType type, ModelConverterContext context, Iterator<ModelConverter> chain) {
+        if (chain.hasNext() && type != null && type.getType() instanceof CollectionType
+                && "_embedded".equalsIgnoreCase(type.getPropertyName())) {
+            Schema<?> schema = chain.next().resolve(type, context, chain);
+            if (schema instanceof ArraySchema) {
+                return new MapSchema()
+                        .name("_embedded")
+                        .additionalProperties(new StringSchema())
+                        .additionalProperties(schema);
+            }
+        }
+        return chain.hasNext() ? chain.next().resolve(type, context, chain) : null;
+    }
+}

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

@@ -0,0 +1,11 @@
+package org.springdoc.core.hal;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+import org.springframework.hateoas.Links;
+import org.springframework.hateoas.mediatype.hal.RepresentationModelMixin;
+
+public abstract class RepresentationModelLinksOASMixin extends RepresentationModelMixin {
+    @Override
+    @Schema(ref = "#/components/schemas/Links")
+    public abstract Links getLinks();
+}