Merge pull request #19 from lcomment/develop/v1.0.2

Merge develop to master

Author: lcomment

example/src/main/kotlin/io/github/lcomment/example/dto/request/ExampleRequest.kt

@@ -18,9 +18,21 @@
 
 package io.github.lcomment.example.dto.request
 
+import io.github.lcomment.example.dto.response.ArrayResponse
+import io.github.lcomment.example.enums.ExampleEnum
 import jakarta.validation.constraints.NotBlank
 
 data class ExampleRequest(
     @field:NotBlank
     val example: String? = null,
-)
+    val arrayData: ArrayResponse = ArrayResponse(),
+    val enumData: ExampleEnum = ExampleEnum.EXAMPLE1,
+    val objectData: ObjectExample = ObjectExample(),
+) {
+
+    data class ObjectExample(
+        val value1: String = "value1",
+        val value2: Int = 1,
+        val value3: Boolean = true,
+    )
+}

example/src/test/kotlin/io/github/lcomment/example/controller/ApiSpec.kt

@@ -140,6 +140,13 @@ internal class ApiSpec {
 
                 requestField {
                     field("example", "example request", "example")
+                    field("arrayData.array1", "Array Data 1", request.arrayData.array1)
+                    field("arrayData.array2", "Array Data 2", request.arrayData.array2)
+                    field("arrayData.array3", "Array Data 3", request.arrayData.array3)
+                    field("enumData", "Enum Data", ExampleEnum.EXAMPLE1)
+                    field("objectData.value1", "Object Value 1", request.objectData.value1)
+                    field("objectData.value2", "Object Value 2", request.objectData.value2)
+                    field("objectData.value3", "Object Value 3", request.objectData.value3)
                 }
             }
     }
@@ -230,7 +237,15 @@ internal class ApiSpec {
             }
 
             requestField {
-                field("example", "example request", "example")
+                field("example", "Example Request", "example")
+                ignoredField("arrayData")
+                field("arrayData.array1", "Array Data 1", listOf("item1", "item2"))
+                field("arrayData.array2", "Array Data 2", setOf("item1", "item2"))
+                field("arrayData.array3", "Array Data 3", arrayOf("item1", "item2"))
+                field("enumData", "Enum Data", ExampleEnum.EXAMPLE1)
+                field("objectData.value1", "Object Value 1", "value1")
+                field("objectData.value2", "Object Value 2", 1)
+                field("objectData.value3", "Object Value 3", true)
             }
 
             responseField {

korest-docs-mockmvc/build.gradle.kts

@@ -13,6 +13,7 @@ dependencies {
     implementation(libs.jackson.databind)
     implementation(libs.jackson.datatype.jsr310)
     implementation(libs.jackson.core)
+    implementation(libs.jackson.module.kotlin)
 
     testImplementation(libs.kotest.junit)
     testImplementation(libs.kotest.assertions.core)

korest-docs-mockmvc/src/main/kotlin/io/github/lcomment/korestdocs/mockmvc/MockMvcDocumentation.kt

@@ -99,7 +99,7 @@ private fun requestHttp(
             header(key, value.toString())
         }
 
-        content = toJson(requestFieldsSpec?.fields ?: emptyMap<String, Any>())
+        content = toJsonString(requestFieldsSpec?.fields ?: emptyMap())
         contentType = MediaType.APPLICATION_JSON
     }
 }
@@ -141,6 +141,39 @@ private fun requestMultipart(
     }
 }
 
+fun toJsonString(flatMap: Map<String, Any>): String {
+    val nestedMap = mutableMapOf<String, Any>()
+
+    val asMap = flatMap.keys
+        .filter { it.contains('.') }
+        .map { it.substringBefore('.') }
+        .toSet()
+
+    for ((key, value) in flatMap) {
+        if (asMap.contains(key) && !key.contains('.')) {
+            continue
+        }
+
+        insert(nestedMap, key, value)
+    }
+
+    return toJson(nestedMap)
+}
+
+fun insert(map: MutableMap<String, Any>, key: String, value: Any) {
+    val dotIndex = key.indexOf('.')
+
+    if (dotIndex == -1) {
+        map[key] = value
+    } else {
+        val first = key.substring(0, dotIndex)
+        val rest = key.substring(dotIndex + 1)
+        val child = map.getOrPut(first) { mutableMapOf<String, Any>() } as MutableMap<String, Any>
+
+        insert(child, rest, value)
+    }
+}
+
 fun toJson(value: Any): String {
     return mapper.writeValueAsString(value)
 }

libs.versions.toml

@@ -51,6 +51,7 @@ spring-boot-starter-security = { module = "org.springframework.boot:spring-boot-
 jackson-core = { module = "com.fasterxml.jackson.core:jackson-core", version.ref = "jackson" }
 jackson-databind = { module = "com.fasterxml.jackson.core:jackson-databind", version.ref = "jackson" }
 jackson-datatype-jsr310 = { module = "com.fasterxml.jackson.datatype:jackson-datatype-jsr310", version.ref = "jackson" }
+jackson-module-kotlin = { module = "com.fasterxml.jackson.module:jackson-module-kotlin", version.ref = "jackson" }
 
 # test
 spring-test = { module = "org.springframework:spring-test", version.ref = "spring6" }