Merge pull request #113 from ghdcksgml1/chore(#111)-swagger-config-ex…

…ample-data chore(#111): Response List 타입의 예시 데이터 안되는 문제 해결
ghdcksgml1 · Nov 15, 2023 · 186ec0a · 186ec0a
2 parents 320ddea + 14ede55
commit 186ec0a
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 3 deletions.
diff --git a/...src/main/java/com/heachi/housework/api/controller/group/member/GroupMemberController.java b/...src/main/java/com/heachi/housework/api/controller/group/member/GroupMemberController.java
@@ -5,6 +5,7 @@
 import com.heachi.housework.api.service.auth.AuthExternalService;
 import com.heachi.housework.api.service.group.member.GroupMemberService;
 import com.heachi.redis.define.housework.todo.TodoList;
+import io.swagger.v3.oas.annotations.media.ArraySchema;
 import io.swagger.v3.oas.annotations.media.Content;
 import io.swagger.v3.oas.annotations.media.Schema;
 import io.swagger.v3.oas.annotations.responses.ApiResponse;
@@ -22,7 +23,7 @@ public class GroupMemberController {
     private final AuthExternalService authExternalService;
     private final GroupMemberService groupMemberService;
 
-    @ApiResponse(responseCode = "200", description = "Group Member 리스트 조회 성공", content = @Content(schema = @Schema(implementation = GroupMemberResponse.class, type = "array")))
+    @ApiResponse(responseCode = "200", description = "Group Member 리스트 조회 성공", content = @Content(array = @ArraySchema(schema = @Schema(implementation = GroupMemberResponse.class))))
     @GetMapping("/{groupId}")
     public JsonResult<?> groupMemberList(@RequestHeader(name = "Authorization") String authorization,
                                          @PathVariable(name = "groupId") Long groupId) {

diff --git a/...a/com/heachi/housework/api/controller/housework/category/HouseworkCategoryController.java b/...a/com/heachi/housework/api/controller/housework/category/HouseworkCategoryController.java
@@ -4,6 +4,7 @@
 import com.heachi.housework.api.controller.group.member.response.GroupMemberResponse;
 import com.heachi.housework.api.service.housework.category.HouseworkCategoryService;
 import com.heachi.housework.api.service.housework.category.response.HouseworkCategoryResponse;
+import io.swagger.v3.oas.annotations.media.ArraySchema;
 import io.swagger.v3.oas.annotations.media.Content;
 import io.swagger.v3.oas.annotations.media.Schema;
 import io.swagger.v3.oas.annotations.responses.ApiResponse;
@@ -21,7 +22,7 @@ public class HouseworkCategoryController {
 
     private final HouseworkCategoryService houseworkCategoryService;
 
-    @ApiResponse(responseCode = "200", description = "카테고리 리스트 조회 성공", content = @Content(schema = @Schema(implementation = HouseworkCategoryResponse.class, type = "array")))
+    @ApiResponse(responseCode = "200", description = "Group Member 리스트 조회 성공", content = @Content(array = @ArraySchema(schema = @Schema(implementation = HouseworkCategoryResponse.class))))
     @GetMapping("/")
     public JsonResult<?> selectCategory() {
 

diff --git a/...-api/src/main/java/com/heachi/housework/api/controller/housework/todo/TodoController.java b/...-api/src/main/java/com/heachi/housework/api/controller/housework/todo/TodoController.java
@@ -10,9 +10,12 @@
 import com.heachi.housework.api.service.housework.todo.request.VerifyTodoServiceRequest;
 import com.heachi.redis.define.housework.todo.TodoList;
 import com.heachi.s3.api.service.AwsS3Service;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.media.ArraySchema;
 import io.swagger.v3.oas.annotations.media.Content;
 import io.swagger.v3.oas.annotations.media.Schema;
 import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import io.swagger.v3.oas.annotations.responses.ApiResponses;
 import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.validation.Valid;
 import lombok.RequiredArgsConstructor;
@@ -32,7 +35,7 @@ public class TodoController {
     private final AwsS3Service awsS3Service;
 
     // Todo List 가져오기
-    @ApiResponse(responseCode = "200", description = "Todo List 조회 성공", content = @Content(schema = @Schema(implementation = TodoList.class)))
+    @ApiResponse(responseCode = "200", description = "성공적으로 Todo List를 조회함", content = @Content(schema = @Schema(implementation = TodoList.class)))
     @GetMapping("/{groupId}")
     public JsonResult<?> selectTodo(@RequestHeader(name = "Authorization") String authorization,
                                     @PathVariable(name = "groupId") Long groupId,