Merge pull request #17 from LeeSM0518/DVK-61-apply-swagger-to-categor…

…y-api

[DVK-61] fix: 카테고리 API에 Swagger 적용

src/main/kotlin/com/devooks/backend/category/v1/controller/CategoryController.kt

@@ -1,31 +1,21 @@
 package com.devooks.backend.category.v1.controller
 
-import com.devooks.backend.category.v1.dto.GetCategoriesRequest
 import com.devooks.backend.category.v1.dto.GetCategoriesResponse
 import com.devooks.backend.category.v1.dto.GetCategoriesResponse.Companion.toResponse
 import com.devooks.backend.category.v1.service.CategoryService
 import org.springframework.web.bind.annotation.GetMapping
 import org.springframework.web.bind.annotation.RequestMapping
-import org.springframework.web.bind.annotation.RequestParam
 import org.springframework.web.bind.annotation.RestController
 
 @RestController
 @RequestMapping("/api/v1/categories")
 class CategoryController(
     private val categoryService: CategoryService,
-) {
+): CategoryControllerDocs {
 
     @GetMapping
-    suspend fun getCategories(
-        @RequestParam(required = false, defaultValue = "")
-        name: String,
-        @RequestParam(required = false, defaultValue = "")
-        page: String,
-        @RequestParam(required = false, defaultValue = "")
-        count: String,
-    ): GetCategoriesResponse {
-        val request = GetCategoriesRequest(name, page, count)
-        return categoryService.get(request).toResponse()
+    override suspend fun getCategories(): GetCategoriesResponse {
+        return categoryService.getAll().toResponse()
     }
 
-}
+}

src/main/kotlin/com/devooks/backend/category/v1/controller/CategoryControllerDocs.kt

@@ -0,0 +1,15 @@
+package com.devooks.backend.category.v1.controller
+
+import com.devooks.backend.category.v1.dto.GetCategoriesResponse
+import io.swagger.v3.oas.annotations.Operation
+import io.swagger.v3.oas.annotations.responses.ApiResponse
+import io.swagger.v3.oas.annotations.responses.ApiResponses
+import io.swagger.v3.oas.annotations.tags.Tag
+
+@Tag(name = "카테고리 API")
+interface CategoryControllerDocs {
+
+    @Operation(summary = "카테고리 목록 조회")
+    @ApiResponses(value = [ApiResponse(responseCode = "200", description = "OK")])
+    suspend fun getCategories(): GetCategoriesResponse
+}

src/main/kotlin/com/devooks/backend/category/v1/service/CategoryService.kt

@@ -2,7 +2,6 @@ package com.devooks.backend.category.v1.service
 
 import com.devooks.backend.category.v1.domain.Category
 import com.devooks.backend.category.v1.domain.Category.Companion.toDomain
-import com.devooks.backend.category.v1.dto.GetCategoriesRequest
 import com.devooks.backend.category.v1.error.CategoryError
 import com.devooks.backend.category.v1.repository.CategoryRepository
 import java.util.*
@@ -16,12 +15,9 @@ class CategoryService(
     private val categoryRepository: CategoryRepository,
 ) {
 
-    suspend fun get(request: GetCategoriesRequest): List<Category> =
+    suspend fun getAll(): List<Category> =
         categoryRepository
-            .findAllByNameLikeIgnoreCase(
-                name = request.keyword,
-                pageable = request.paging.value
-            )
+            .findAll()
             .map { it.toDomain() }
             .toList()
 

src/test/kotlin/com/devooks/backend/category/v1/controller/CategoryControllerTest.kt

@@ -48,7 +48,7 @@ internal class CategoryControllerTest @Autowired constructor(
         // when
         val categories = webTestClient
             .get()
-            .uri("/api/v1/categories?page=1&count=10")
+            .uri("/api/v1/categories")
             .accept(APPLICATION_JSON)
             .exchange()
             .expectStatus().isOk