Skip to content

Commit a7d9a67

Browse files
Acho-mjAcho-mj
committed
docs: Swagger 문서의 data 필드에 실제 응답 예시 추가 in MemberApi
1 parent 8f916b4 commit a7d9a67

File tree

1 file changed

+144
-16
lines changed
  • src/main/java/BE_Elixir/Elixir/domain/member/controller/api

1 file changed

+144
-16
lines changed

‎src/main/java/BE_Elixir/Elixir/domain/member/controller/api/MemberApi.java‎

Lines changed: 144 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -395,8 +395,13 @@ public ResponseEntity<CommonResponse<MemberProfileResponseDTO>> getOtherMemberPr
395395
{
396396
"status": 200,
397397
"code": "200 OK",
398-
"message": "내가 작성한 레시피 조회 성공",
399-
"data": true
398+
"message": "내 레시피 조회 성공",
399+
"data": [
400+
{
401+
"recipeId": 49,
402+
"imageUrl": "https://image.com"
403+
}
404+
]
400405
}
401406
""")))
402407
})
@@ -415,7 +420,16 @@ ResponseEntity<CommonResponse<List<RecipeImageResponseDTO>>> getMyRecipes(
415420
"status": 200,
416421
"code": "200 OK",
417422
"message": "내가 스크랩한 레시피 조회 성공",
418-
"data": true
423+
"data": [
424+
{
425+
"recipeId": 1,
426+
"imageUrl": "http://www.foodsafetykorea.go.kr/uploadimg/cook/10_00028_1.png"
427+
},
428+
{
429+
"recipeId": 2,
430+
"imageUrl": "http://www.foodsafetykorea.go.kr/uploadimg/cook/10_00029_1.png"
431+
}
432+
]
419433
}
420434
""")))
421435
})
@@ -642,11 +656,47 @@ ResponseEntity<CommonResponse<List<MemberSummaryDTO>>> getFollowerByMemberId(
642656
content = @Content(schema = @Schema(implementation = CommonResponse.class),
643657
examples = @ExampleObject(value = """
644658
{
645-
"status": 200,
646-
"code": "200 OK",
647-
"message": "로그인한 사용자의 모든 챌린지 업적 정보 조회 성공",
648-
"data": true
649-
}
659+
"status": 200,
660+
"code": "200 OK",
661+
"message": "모든 챌린지 업적 조회 성공",
662+
"data": [
663+
{
664+
"year": 2025,
665+
"month": 2,
666+
"achievementName": "비타민 수호자",
667+
"achievementImageUrl": "https://example.com/images/color_2.png",
668+
"challengeCompleted": true
669+
},
670+
{
671+
"year": 2025,
672+
"month": 3,
673+
"achievementName": "비타민 수호자",
674+
"achievementImageUrl": "https://example.com/images/color_3.png",
675+
"challengeCompleted": true
676+
},
677+
{
678+
"year": 2025,
679+
"month": 4,
680+
"achievementName": "비타민 수호자",
681+
"achievementImageUrl": "https://example.com/images/color_4.png",
682+
"challengeCompleted": true
683+
},
684+
{
685+
"year": 2025,
686+
"month": 5,
687+
"achievementName": "비타민 수호자",
688+
"achievementImageUrl": "https://example.com/images/gray_5.png",
689+
"challengeCompleted": false
690+
},
691+
{
692+
"year": 2025,
693+
"month": 6,
694+
"achievementName": "비타민 수호자",
695+
"achievementImageUrl": "https://example.com/images/gray_6.png",
696+
"challengeCompleted": false
697+
}
698+
]
699+
}
650700
""")))
651701
})
652702
ResponseEntity<CommonResponse<List<MemberAchievementResponseDTO>>> getAllAchievements(
@@ -664,8 +714,30 @@ ResponseEntity<CommonResponse<List<MemberAchievementResponseDTO>>> getAllAchieve
664714
{
665715
"status": 200,
666716
"code": "200 OK",
667-
"message": "로그인한 사용자의 달성한 업적 최신 3개 조회 성공",
668-
"data": true
717+
"message": "최근 업적 3개 조회 성공",
718+
"data": [
719+
{
720+
"year": 2025,
721+
"month": 4,
722+
"achievementName": "비타민 수호자",
723+
"achievementImageUrl": "https://example.com/images/color_4.png",
724+
"challengeCompleted": true
725+
},
726+
{
727+
"year": 2025,
728+
"month": 3,
729+
"achievementName": "비타민 수호자",
730+
"achievementImageUrl": "https://example.com/images/color_3.png",
731+
"challengeCompleted": true
732+
},
733+
{
734+
"year": 2025,
735+
"month": 2,
736+
"achievementName": "비타민 수호자",
737+
"achievementImageUrl": "https://example.com/images/color_2.png",
738+
"challengeCompleted": true
739+
}
740+
]
669741
}
670742
""")))
671743
})
@@ -756,8 +828,24 @@ ResponseEntity<CommonResponse<SurveyResponseDTO>> updateSurvey(
756828
{
757829
"status": 200,
758830
"code": "200 OK",
759-
"message": "다른 사용자가 업로드한 모든 레시피 조회 성공",
760-
"data": true
831+
"message": "다른 사용자 레시피 조회 성공",
832+
"data": [
833+
{
834+
"recipeId": 1,
835+
"imageUrl": "http://www.foodsafetykorea.go.kr/uploadimg/cook/10_00028_1.png"
836+
},
837+
{
838+
"recipeId": 2,
839+
"imageUrl": "http://www.foodsafetykorea.go.kr/uploadimg/cook/10_00029_1.png"
840+
},
841+
.
842+
.
843+
.
844+
{
845+
"recipeId": 9,
846+
"imageUrl": "http://www.foodsafetykorea.go.kr/uploadimg/cook/10_00089_1.png"
847+
}
848+
]
761849
}
762850
""")))
763851
})
@@ -776,8 +864,26 @@ ResponseEntity<CommonResponse<List<RecipeImageResponseDTO>>> getUserRecipes(
776864
{
777865
"status": 200,
778866
"code": "200 OK",
779-
"message": "다른 사용자의 모든 챌린지 업적 정보 조회 성공",
780-
"data": true
867+
"message": "다른 사용자의 모든 업적 조회 성공",
868+
"data": [
869+
{
870+
"year": 2025,
871+
"month": 2,
872+
"achievementName": "비타민 수호자",
873+
"achievementImageUrl": "https://example.com/images/gray_2.png",
874+
"challengeCompleted": false
875+
},
876+
.
877+
.
878+
.
879+
{
880+
"year": 2025,
881+
"month": 6,
882+
"achievementName": "비타민 수호자",
883+
"achievementImageUrl": "https://example.com/images/gray_6.png",
884+
"challengeCompleted": false
885+
}
886+
]
781887
}
782888
""")))
783889
})
@@ -796,8 +902,30 @@ ResponseEntity<CommonResponse<List<MemberAchievementResponseDTO>>> getAllAchieve
796902
{
797903
"status": 200,
798904
"code": "200 OK",
799-
"message": "다른 사용자의 최근 3개 업적 조회 성공",
800-
"data": true
905+
"message": "다른 사용자의 최근 업적 3개 조회 성공",
906+
"data": [
907+
{
908+
"year": 2025,
909+
"month": 4,
910+
"achievementName": "비타민 수호자",
911+
"achievementImageUrl": "https://example.com/images/color_4.png",
912+
"challengeCompleted": true
913+
},
914+
{
915+
"year": 2025,
916+
"month": 3,
917+
"achievementName": "비타민 수호자",
918+
"achievementImageUrl": "https://example.com/images/color_3.png",
919+
"challengeCompleted": true
920+
},
921+
{
922+
"year": 2025,
923+
"month": 2,
924+
"achievementName": "비타민 수호자",
925+
"achievementImageUrl": "https://example.com/images/color_2.png",
926+
"challengeCompleted": true
927+
}
928+
]
801929
}
802930
""")))
803931
})

0 commit comments

Comments
 (0)