Feat: add documentation function and improve multipart function

example/build.gradle.kts

@@ -11,6 +11,7 @@ val snippetsDir by extra { file("build/generated-snippets") }
 dependencies {
     implementation(projects.mockmvc)
     implementation(libs.spring.boot.starter.web)
+    implementation(libs.spring.boot.starter.validation)
 
     testImplementation(libs.spring.boot.starter.test)
 

example/src/main/kotlin/io/github/lcomment/example/Application.kt

@@ -1,3 +1,21 @@
+/*
+ * Korest Docs
+ *
+ * Copyright 2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package io.github.lcomment.example
 
 import jakarta.annotation.PostConstruct

example/src/main/kotlin/io/github/lcomment/example/controller/ExampleController.kt

@@ -1,10 +1,35 @@
+/*
+ * Korest Docs
+ *
+ * Copyright 2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package io.github.lcomment.example.controller
 
+import io.github.lcomment.example.dto.request.ExampleMultipartRequest
+import io.github.lcomment.example.dto.request.ExampleRequest
 import io.github.lcomment.example.dto.response.ApiResponse
 import io.github.lcomment.example.dto.response.ExampleResponse
 import io.github.lcomment.example.service.ExampleService
+import jakarta.validation.Valid
+import org.springframework.http.MediaType
 import org.springframework.web.bind.annotation.GetMapping
+import org.springframework.web.bind.annotation.ModelAttribute
 import org.springframework.web.bind.annotation.PathVariable
+import org.springframework.web.bind.annotation.PostMapping
+import org.springframework.web.bind.annotation.RequestBody
 import org.springframework.web.bind.annotation.RestController
 
 @RestController
@@ -20,4 +45,26 @@ class ExampleController(
 
         return ApiResponse.success(data)
     }
+
+    @PostMapping("/example/{id}")
+    fun post(
+        @PathVariable id: Long,
+        @RequestBody @Valid request: ExampleRequest,
+    ): ApiResponse<Unit> {
+        exampleService.post(request)
+
+        return ApiResponse.success()
+    }
+
+    @PostMapping(
+        "/example",
+        consumes = [MediaType.MULTIPART_FORM_DATA_VALUE],
+        produces = [MediaType.APPLICATION_JSON_VALUE],
+    )
+    fun saveImages(
+        @ModelAttribute @Valid request: ExampleMultipartRequest,
+//        @RequestParam message: String,
+    ): ApiResponse<Unit> {
+        return ApiResponse.success()
+    }
 }

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

@@ -0,0 +1,10 @@
+package io.github.lcomment.example.dto.request
+
+import jakarta.validation.constraints.NotBlank
+import org.springframework.web.multipart.MultipartFile
+
+data class ExampleMultipartRequest(
+    val images: List<MultipartFile> = emptyList(),
+    @field:NotBlank
+    var message: String? = null,
+)

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

@@ -0,0 +1,26 @@
+/*
+ * Korest Docs
+ *
+ * Copyright 2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.github.lcomment.example.dto.request
+
+import jakarta.validation.constraints.NotBlank
+
+data class ExampleRequest(
+    @field:NotBlank
+    val example: String? = null,
+)

example/src/main/kotlin/io/github/lcomment/example/dto/response/ApiResponse.kt

@@ -1,7 +1,27 @@
+/*
+ * Korest Docs
+ *
+ * Copyright 2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package io.github.lcomment.example.dto.response
 
 import io.github.lcomment.example.enums.ReturnCode
+import com.fasterxml.jackson.annotation.JsonInclude
 
+@JsonInclude(JsonInclude.Include.NON_NULL)
 data class ApiResponse<T>(
     val code: String,
     val message: String,

example/src/main/kotlin/io/github/lcomment/example/dto/response/ArrayResponse.kt

@@ -1,3 +1,21 @@
+/*
+ * Korest Docs
+ *
+ * Copyright 2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package io.github.lcomment.example.dto.response
 
 data class ArrayResponse(

example/src/main/kotlin/io/github/lcomment/example/dto/response/DateResponse.kt

@@ -1,3 +1,21 @@
+/*
+ * Korest Docs
+ *
+ * Copyright 2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package io.github.lcomment.example.dto.response
 
 import java.time.LocalDate

example/src/main/kotlin/io/github/lcomment/example/dto/response/ExampleResponse.kt

@@ -1,3 +1,21 @@
+/*
+ * Korest Docs
+ *
+ * Copyright 2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package io.github.lcomment.example.dto.response
 
 import io.github.lcomment.example.enums.ExampleEnum

example/src/main/kotlin/io/github/lcomment/example/dto/response/NumberResponse.kt

@@ -1,3 +1,21 @@
+/*
+ * Korest Docs
+ *
+ * Copyright 2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package io.github.lcomment.example.dto.response
 
 data class NumberResponse(

example/src/main/kotlin/io/github/lcomment/example/enums/ExampleEnum.kt

@@ -1,3 +1,21 @@
+/*
+ * Korest Docs
+ *
+ * Copyright 2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package io.github.lcomment.example.enums
 
 enum class ExampleEnum {

example/src/main/kotlin/io/github/lcomment/example/enums/ReturnCode.kt

@@ -1,3 +1,21 @@
+/*
+ * Korest Docs
+ *
+ * Copyright 2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package io.github.lcomment.example.enums
 
 enum class ReturnCode(

example/src/main/kotlin/io/github/lcomment/example/service/ExampleService.kt

@@ -1,5 +1,24 @@
+/*
+ * Korest Docs
+ *
+ * Copyright 2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package io.github.lcomment.example.service
 
+import io.github.lcomment.example.dto.request.ExampleRequest
 import io.github.lcomment.example.dto.response.ExampleResponse
 import org.springframework.stereotype.Service
 
@@ -9,4 +28,10 @@ class ExampleService {
     fun get(): ExampleResponse {
         return ExampleResponse()
     }
+
+    fun post(
+        request: ExampleRequest,
+    ) {
+        // do nothing
+    }
 }