From 86c8b0a3db945427e2b88e1c7bc2c877258b54e8 Mon Sep 17 00:00:00 2001 From: yeonjy Date: Sun, 30 Jun 2024 18:45:09 +0900 Subject: [PATCH] =?UTF-8?q?feat:=20success=20message=20=EC=88=98=EC=A0=95?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../domain/bookmark/api/BookmarkApi.java | 8 ++++---- .../backend/domain/debate/api/DebateApi.java | 18 +++++++++--------- .../backend/domain/member/api/MemberApi.java | 2 +- .../backend/domain/news/api/NewsApi.java | 4 ++-- .../domain/readNews/api/ReadNewsApi.java | 2 +- .../domain/statistics/api/StatisticsApi.java | 4 ++-- 6 files changed, 19 insertions(+), 19 deletions(-) diff --git a/backend/core/src/main/java/com/rollthedice/backend/domain/bookmark/api/BookmarkApi.java b/backend/core/src/main/java/com/rollthedice/backend/domain/bookmark/api/BookmarkApi.java index e8afb30..7eff090 100644 --- a/backend/core/src/main/java/com/rollthedice/backend/domain/bookmark/api/BookmarkApi.java +++ b/backend/core/src/main/java/com/rollthedice/backend/domain/bookmark/api/BookmarkApi.java @@ -21,7 +21,7 @@ public interface BookmarkApi { ) @ApiResponse( responseCode = "200", - description = "OK" + description = "북마크 전체 조회를 성공했습니다." ) SuccessResponse> getAllBookmarkedNews( Pageable pageable @@ -35,7 +35,7 @@ SuccessResponse> getAllBookmarkedNews( ) @ApiResponse( responseCode = "200", - description = "OK" + description = "뉴스가 북마크 여부 조회를 성공했습니다." ) SuccessResponse getIsBookmarked( @Parameter(in = ParameterIn.PATH, description = "뉴스 ID", required = true) @@ -51,7 +51,7 @@ SuccessResponse getIsBookmarked( ) @ApiResponse( responseCode = "201", - description = "Created" + description = "북마크 저장에 성공했습니다." ) SuccessResponse saveBookmark( @Parameter(in = ParameterIn.PATH, description = "뉴스 ID", required = true) @@ -66,7 +66,7 @@ SuccessResponse saveBookmark( ) @ApiResponse( responseCode = "204", - description = "No Content" + description = "북마크 삭제에 성공했습니다." ) SuccessResponse deleteBookmark( @Parameter(in = ParameterIn.PATH, description = "뉴스 ID", required = true) diff --git a/backend/core/src/main/java/com/rollthedice/backend/domain/debate/api/DebateApi.java b/backend/core/src/main/java/com/rollthedice/backend/domain/debate/api/DebateApi.java index b61ada2..f109328 100644 --- a/backend/core/src/main/java/com/rollthedice/backend/domain/debate/api/DebateApi.java +++ b/backend/core/src/main/java/com/rollthedice/backend/domain/debate/api/DebateApi.java @@ -29,7 +29,7 @@ public interface DebateApi { ) @ApiResponse( responseCode = "201", - description = "Created" + description = "토론방 생성에 성공했습니다." ) SuccessResponse saveDebateRoom(@RequestBody DebateRoomRequest request); @@ -41,7 +41,7 @@ public interface DebateApi { ) @ApiResponse( responseCode = "200", - description = "요청에 성공하였습니다." + description = "토론방 전체 조회에 성공했습니다" ) SuccessResponse> getDebateRooms(Pageable pageable); @@ -53,7 +53,7 @@ public interface DebateApi { ) @ApiResponse( responseCode = "204", - description = "토론방 삭제에 성공하였으며, 응답값은 없습니다." + description = "토론방 삭제에 성공했습니다." ) SuccessResponse deleteDebateRoom(@Parameter(in = ParameterIn.PATH, description = "토론방 ID", required = true) Long roomId @@ -67,7 +67,7 @@ SuccessResponse deleteDebateRoom(@Parameter(in = ParameterIn.PATH, descr ) @ApiResponse( responseCode = "201", - description = "Created" + description = "사용자가 보낸 토론 메세지 저장에 성공했습니다." ) SuccessResponse saveHumanDebateMessage( @Parameter(in = ParameterIn.PATH, description = "토론방 ID", required = true) @@ -84,7 +84,7 @@ SuccessResponse saveHumanDebateMessage( ) @ApiResponse( responseCode = "201", - description = "Created" + description = "AI가 보낸 토론 메세지 저장에 성공했습니다." ) SuccessResponse saveAIDebateMessage( @Parameter(in = ParameterIn.PATH, description = "토론방 ID", required = true) @@ -102,7 +102,7 @@ SuccessResponse saveAIDebateMessage( @ApiResponses(value = { @ApiResponse( responseCode = "204", - description = "요청에 성공하였으며 응답값은 없습니다." + description = "토론 종료에 성공했습니다." ), @ApiResponse( responseCode = "404", @@ -122,7 +122,7 @@ SuccessResponse finishDebate( ) @ApiResponse( responseCode = "200", - description = "요청에 성공하였습니다." + description = "토론 메세지 조회에 성공했습니다." ) SuccessResponse> getDebateMessages( @Parameter(in = ParameterIn.PATH, description = "토론방 ID", required = true) @@ -138,7 +138,7 @@ SuccessResponse> getDebateMessages( @ApiResponses(value = { @ApiResponse( responseCode = "201", - description = "토론 요약이 성공하였습니다." + description = "토론 요약에 성공했습니다." ), @ApiResponse( responseCode = "404", @@ -159,7 +159,7 @@ SuccessResponse summarizeDebate( @ApiResponses(value = { @ApiResponse( responseCode = "200", - description = "요청에 성공하였습니다." + description = "토론 요약 조회에 성공했습니다." ), @ApiResponse( responseCode = "404", diff --git a/backend/core/src/main/java/com/rollthedice/backend/domain/member/api/MemberApi.java b/backend/core/src/main/java/com/rollthedice/backend/domain/member/api/MemberApi.java index 273ade9..fcb8ad1 100644 --- a/backend/core/src/main/java/com/rollthedice/backend/domain/member/api/MemberApi.java +++ b/backend/core/src/main/java/com/rollthedice/backend/domain/member/api/MemberApi.java @@ -15,7 +15,7 @@ public interface MemberApi { ) @ApiResponse( responseCode = "200", - description = "OK" + description = "사용자 정보 조회에 성공했습니다." ) SuccessResponse getMemberInfo(); } diff --git a/backend/core/src/main/java/com/rollthedice/backend/domain/news/api/NewsApi.java b/backend/core/src/main/java/com/rollthedice/backend/domain/news/api/NewsApi.java index 5cc4c90..78b8356 100644 --- a/backend/core/src/main/java/com/rollthedice/backend/domain/news/api/NewsApi.java +++ b/backend/core/src/main/java/com/rollthedice/backend/domain/news/api/NewsApi.java @@ -23,7 +23,7 @@ public interface NewsApi { ) @ApiResponse( responseCode = "200", - description = "요청에 성공하였습니다." + description = "전체 뉴스 조회에 성공했습니다." ) SuccessResponse> getNews(Pageable pageable); @@ -36,7 +36,7 @@ public interface NewsApi { @ApiResponses(value = { @ApiResponse( responseCode = "200", - description = "요청에 성공하였습니다." + description = "요약 뉴스 상세 조회에 성공했습니다." ), @ApiResponse( responseCode = "404", diff --git a/backend/core/src/main/java/com/rollthedice/backend/domain/readNews/api/ReadNewsApi.java b/backend/core/src/main/java/com/rollthedice/backend/domain/readNews/api/ReadNewsApi.java index d8e86ce..d52f706 100644 --- a/backend/core/src/main/java/com/rollthedice/backend/domain/readNews/api/ReadNewsApi.java +++ b/backend/core/src/main/java/com/rollthedice/backend/domain/readNews/api/ReadNewsApi.java @@ -17,7 +17,7 @@ public interface ReadNewsApi { ) @ApiResponse( responseCode = "200", - description = "요청에 성공하였습니다." + description = "최근 읽은 뉴스 조회에 성공했습니다." ) SuccessResponse> getReadNews(); } diff --git a/backend/core/src/main/java/com/rollthedice/backend/domain/statistics/api/StatisticsApi.java b/backend/core/src/main/java/com/rollthedice/backend/domain/statistics/api/StatisticsApi.java index 04993f4..80066dd 100644 --- a/backend/core/src/main/java/com/rollthedice/backend/domain/statistics/api/StatisticsApi.java +++ b/backend/core/src/main/java/com/rollthedice/backend/domain/statistics/api/StatisticsApi.java @@ -18,7 +18,7 @@ public interface StatisticsApi { ) @ApiResponse( responseCode = "200", - description = "요청에 성공하였습니다." + description = "최근 일주일 날짜별 뉴스 조회수 조회에 성공했습니다." ) SuccessResponse> getViewsOfDates(); @@ -30,7 +30,7 @@ public interface StatisticsApi { ) @ApiResponse( responseCode = "200", - description = "요청에 성공하였습니다." + description = "카테고리별 조회수 조회에 성공했습니다." ) SuccessResponse> getCategoryStatistics(); }