#327 docs: fridge 관련 response swagger 추가

IceButler · Jul 11, 2024 · 457ea93 · 457ea93
1 parent 6ad77c6
commit 457ea93
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 14 deletions.
diff --git a/src/main/java/com/example/icebutler_server/fridge/dto/response/FridgeFoodStatistics.java b/src/main/java/com/example/icebutler_server/fridge/dto/response/FridgeFoodStatistics.java
@@ -1,5 +1,6 @@
 package com.example.icebutler_server.fridge.dto.response;
 
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.AllArgsConstructor;
 import lombok.Builder;
 import lombok.Data;
@@ -9,12 +10,14 @@
 @Builder
 @AllArgsConstructor
 @NoArgsConstructor
+@Schema(name = "FridgeFoodStatistics", description = "냉장고 식품 삭제 통계 정보")
 public class FridgeFoodStatistics {
+    @Schema(name = "foodCategory", description = "식품 카테고리")
     private String foodCategory;
+    @Schema(name = "foodCategoryImgUrl", description = "식품 카테고리 이미지 URL")
     private String foodCategoryImgUrl;
+    @Schema(name = "percentage", description = "삭제 비율")
     private Double percentage;
+    @Schema(name = "count", description = "삭제 개수")
     private Integer count;
-
-
-
 }
diff --git a/src/main/java/com/example/icebutler_server/fridge/dto/response/FridgeFoodsStatistics.java b/src/main/java/com/example/icebutler_server/fridge/dto/response/FridgeFoodsStatistics.java
@@ -1,5 +1,6 @@
 package com.example.icebutler_server.fridge.dto.response;
 
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.AllArgsConstructor;
 import lombok.Builder;
 import lombok.Data;
@@ -11,11 +12,13 @@
 @Builder
 @AllArgsConstructor
 @NoArgsConstructor
+@Schema(name = "FridgeFoodsStatistics", description = "식품 카테고리별 삭제 통계 목록")
 public class FridgeFoodsStatistics {
 
+    @Schema(name = "foodStatisticsList", description = "식품 삭제 통계 목록")
     private List<FridgeFoodStatistics> foodStatisticsList;
 
-    public static FridgeFoodsStatistics toDto(List<FridgeFoodStatistics> list){
+    public static FridgeFoodsStatistics toDto(List<FridgeFoodStatistics> list) {
         return new FridgeFoodsStatistics(list);
     }
 

diff --git a/src/main/java/com/example/icebutler_server/fridge/dto/response/UpdateMembersRes.java b/src/main/java/com/example/icebutler_server/fridge/dto/response/UpdateMembersRes.java
@@ -1,6 +1,7 @@
 package com.example.icebutler_server.fridge.dto.response;
 
 import com.example.icebutler_server.fridge.entity.FridgeUser;
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Builder;
 import lombok.Data;
 import lombok.NoArgsConstructor;
@@ -9,17 +10,20 @@
 
 @Data
 @NoArgsConstructor
+@Schema(name = "UpdateMembersRes", description = "냉장고 사용자 변경 정보")
 public class UpdateMembersRes {
-  private List<FridgeUser> withDrawMember;
-  private List<FridgeUser> checkNewMember;
+    @Schema(name = "withDrawMember", description = "냉장고 탈퇴 사용자 목록")
+    private List<FridgeUser> withDrawMember;
+    @Schema(name = "checkNewMember", description = "냉장고 가입 사용자 목록")
+    private List<FridgeUser> checkNewMember;
 
-  @Builder
-  public UpdateMembersRes(List<FridgeUser> withDrawMember, List<FridgeUser> checkNewMember) {
-    this.withDrawMember = withDrawMember;
-    this.checkNewMember = checkNewMember;
-  }
+    @Builder
+    public UpdateMembersRes(List<FridgeUser> withDrawMember, List<FridgeUser> checkNewMember) {
+        this.withDrawMember = withDrawMember;
+        this.checkNewMember = checkNewMember;
+    }
 
-  public static UpdateMembersRes toDto(List<FridgeUser> withDrawMember, List<FridgeUser> checkNewMember) {
-    return UpdateMembersRes.builder().withDrawMember(withDrawMember).checkNewMember(checkNewMember).build();
-  }
+    public static UpdateMembersRes toDto(List<FridgeUser> withDrawMember, List<FridgeUser> checkNewMember) {
+        return UpdateMembersRes.builder().withDrawMember(withDrawMember).checkNewMember(checkNewMember).build();
+    }
 }