From 12af42ee1228c80ad6700261351fc5616bc18d88 Mon Sep 17 00:00:00 2001 From: thguss Date: Tue, 12 Mar 2024 22:15:57 +0900 Subject: [PATCH 1/3] =?UTF-8?q?[CHORE]=20=EC=8A=A4=EC=9B=A8=EA=B1=B0=20?= =?UTF-8?q?=EC=9D=B4=EC=82=AC?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../com/smeem/api/diary/api/DiaryApi.java | 65 +++++++++++++++++++ .../DiaryApiController.java} | 14 ++-- .../dto/request/DiaryCreateRequest.java | 2 +- .../dto/request/DiaryModifyRequest.java | 2 +- .../dto/response/DiaryCreateResponse.java | 2 +- .../dto/response/DiaryGetResponse.java | 2 +- .../dto/response/DiaryListGetResponse.java | 2 +- .../request/DiaryCreateServiceRequest.java | 2 +- .../request/DiaryModifyServiceRequest.java | 2 +- .../java/com/smeem/api/goal/api/GoalApi.java | 29 +++++++++ .../GoalApiController.java} | 8 +-- .../dto/response/GoalGetResponse.java | 2 +- .../dto/response/GoalListGetResponse.java | 2 +- .../com/smeem/api/topic/api/TopicApi.java | 18 +++++ .../TopicApiController.java} | 6 +- .../dto/response/RandomTopicGetResponse.java | 2 +- .../api/controller/DiaryControllerTest.java | 4 +- 17 files changed, 138 insertions(+), 26 deletions(-) create mode 100644 smeem-api/src/main/java/com/smeem/api/diary/api/DiaryApi.java rename smeem-api/src/main/java/com/smeem/api/diary/{controller/DiaryController.java => api/DiaryApiController.java} (87%) rename smeem-api/src/main/java/com/smeem/api/diary/{controller => api}/dto/request/DiaryCreateRequest.java (70%) rename smeem-api/src/main/java/com/smeem/api/diary/{controller => api}/dto/request/DiaryModifyRequest.java (70%) rename smeem-api/src/main/java/com/smeem/api/diary/{controller => api}/dto/response/DiaryCreateResponse.java (92%) rename smeem-api/src/main/java/com/smeem/api/diary/{controller => api}/dto/response/DiaryGetResponse.java (94%) rename smeem-api/src/main/java/com/smeem/api/diary/{controller => api}/dto/response/DiaryListGetResponse.java (96%) create mode 100644 smeem-api/src/main/java/com/smeem/api/goal/api/GoalApi.java rename smeem-api/src/main/java/com/smeem/api/goal/{controller/GoalController.java => api/GoalApiController.java} (87%) rename smeem-api/src/main/java/com/smeem/api/goal/{controller => api}/dto/response/GoalGetResponse.java (92%) rename smeem-api/src/main/java/com/smeem/api/goal/{controller => api}/dto/response/GoalListGetResponse.java (95%) create mode 100644 smeem-api/src/main/java/com/smeem/api/topic/api/TopicApi.java rename smeem-api/src/main/java/com/smeem/api/topic/{controller/TopicController.java => api/TopicApiController.java} (85%) rename smeem-api/src/main/java/com/smeem/api/topic/{controller => api}/dto/response/RandomTopicGetResponse.java (90%) diff --git a/smeem-api/src/main/java/com/smeem/api/diary/api/DiaryApi.java b/smeem-api/src/main/java/com/smeem/api/diary/api/DiaryApi.java new file mode 100644 index 00000000..682d4dd2 --- /dev/null +++ b/smeem-api/src/main/java/com/smeem/api/diary/api/DiaryApi.java @@ -0,0 +1,65 @@ +package com.smeem.api.diary.api; + +import com.smeem.api.common.BaseResponse; +import com.smeem.api.diary.api.dto.request.DiaryCreateRequest; +import com.smeem.api.diary.api.dto.request.DiaryModifyRequest; +import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.responses.ApiResponse; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.PathVariable; +import org.springframework.web.bind.annotation.RequestBody; +import org.springframework.web.bind.annotation.RequestParam; + +import java.security.Principal; + +public interface DiaryApi { + + @Operation( + summary = "일기 생성", + responses = { + @ApiResponse(responseCode = "201", description = "성공"), + @ApiResponse(responseCode = "500", description = "서버 내부 오류") + } + ) + ResponseEntity> createDiary(Principal principal, @RequestBody DiaryCreateRequest request); + + @Operation( + summary = "일기 상세 조회", + responses = { + @ApiResponse(responseCode = "200", description = "성공"), + @ApiResponse(responseCode = "500", description = "서버 내부 오류") + } + ) + ResponseEntity> getDiaryDetail(@PathVariable long diaryId); + + @Operation( + summary = "일기 수정", + responses = { + @ApiResponse(responseCode = "200", description = "성공"), + @ApiResponse(responseCode = "500", description = "서버 내부 오류") + } + ) + ResponseEntity> modifyDiary(@PathVariable long diaryId, @RequestBody DiaryModifyRequest request); + + @Operation( + summary = "일기 삭제", + responses = { + @ApiResponse(responseCode = "200", description = "성공"), + @ApiResponse(responseCode = "500", description = "서버 내부 오류") + } + ) + ResponseEntity> deleteDiary(@PathVariable long diaryId); + + @Operation( + summary = "기간 내 일기 목록 조회", + responses = { + @ApiResponse(responseCode = "200", description = "성공"), + @ApiResponse(responseCode = "500", description = "서버 내부 오류") + } + ) + ResponseEntity> getDiaries( + Principal principal, + @RequestParam String start, + @RequestParam String end + ); +} diff --git a/smeem-api/src/main/java/com/smeem/api/diary/controller/DiaryController.java b/smeem-api/src/main/java/com/smeem/api/diary/api/DiaryApiController.java similarity index 87% rename from smeem-api/src/main/java/com/smeem/api/diary/controller/DiaryController.java rename to smeem-api/src/main/java/com/smeem/api/diary/api/DiaryApiController.java index b75a5f8f..7192fe4c 100644 --- a/smeem-api/src/main/java/com/smeem/api/diary/controller/DiaryController.java +++ b/smeem-api/src/main/java/com/smeem/api/diary/api/DiaryApiController.java @@ -1,14 +1,14 @@ -package com.smeem.api.diary.controller; +package com.smeem.api.diary.api; import java.security.Principal; import com.smeem.api.common.ApiResponseUtil; import com.smeem.api.common.BaseResponse; -import com.smeem.api.diary.controller.dto.request.DiaryCreateRequest; -import com.smeem.api.diary.controller.dto.request.DiaryModifyRequest; -import com.smeem.api.diary.controller.dto.response.DiaryCreateResponse; -import com.smeem.api.diary.controller.dto.response.DiaryGetResponse; -import com.smeem.api.diary.controller.dto.response.DiaryListGetResponse; +import com.smeem.api.diary.api.dto.request.DiaryCreateRequest; +import com.smeem.api.diary.api.dto.request.DiaryModifyRequest; +import com.smeem.api.diary.api.dto.response.DiaryCreateResponse; +import com.smeem.api.diary.api.dto.response.DiaryGetResponse; +import com.smeem.api.diary.api.dto.response.DiaryListGetResponse; import com.smeem.api.diary.service.DiaryQueryService; import com.smeem.api.diary.service.DiaryCommandService; import com.smeem.api.diary.service.dto.request.*; @@ -33,7 +33,7 @@ @RestController @RequiredArgsConstructor @RequestMapping("/api/v2/diaries") -public class DiaryController { +public class DiaryApiController implements DiaryApi { private final DiaryCommandService diaryCommandService; private final DiaryQueryService diaryQueryService; diff --git a/smeem-api/src/main/java/com/smeem/api/diary/controller/dto/request/DiaryCreateRequest.java b/smeem-api/src/main/java/com/smeem/api/diary/api/dto/request/DiaryCreateRequest.java similarity index 70% rename from smeem-api/src/main/java/com/smeem/api/diary/controller/dto/request/DiaryCreateRequest.java rename to smeem-api/src/main/java/com/smeem/api/diary/api/dto/request/DiaryCreateRequest.java index 3b4cf852..ac6c2d0e 100644 --- a/smeem-api/src/main/java/com/smeem/api/diary/controller/dto/request/DiaryCreateRequest.java +++ b/smeem-api/src/main/java/com/smeem/api/diary/api/dto/request/DiaryCreateRequest.java @@ -1,4 +1,4 @@ -package com.smeem.api.diary.controller.dto.request; +package com.smeem.api.diary.api.dto.request; import lombok.NonNull; diff --git a/smeem-api/src/main/java/com/smeem/api/diary/controller/dto/request/DiaryModifyRequest.java b/smeem-api/src/main/java/com/smeem/api/diary/api/dto/request/DiaryModifyRequest.java similarity index 70% rename from smeem-api/src/main/java/com/smeem/api/diary/controller/dto/request/DiaryModifyRequest.java rename to smeem-api/src/main/java/com/smeem/api/diary/api/dto/request/DiaryModifyRequest.java index 8377c67f..c858567e 100644 --- a/smeem-api/src/main/java/com/smeem/api/diary/controller/dto/request/DiaryModifyRequest.java +++ b/smeem-api/src/main/java/com/smeem/api/diary/api/dto/request/DiaryModifyRequest.java @@ -1,4 +1,4 @@ -package com.smeem.api.diary.controller.dto.request; +package com.smeem.api.diary.api.dto.request; import lombok.NonNull; diff --git a/smeem-api/src/main/java/com/smeem/api/diary/controller/dto/response/DiaryCreateResponse.java b/smeem-api/src/main/java/com/smeem/api/diary/api/dto/response/DiaryCreateResponse.java similarity index 92% rename from smeem-api/src/main/java/com/smeem/api/diary/controller/dto/response/DiaryCreateResponse.java rename to smeem-api/src/main/java/com/smeem/api/diary/api/dto/response/DiaryCreateResponse.java index c06ee419..dbbe5096 100644 --- a/smeem-api/src/main/java/com/smeem/api/diary/controller/dto/response/DiaryCreateResponse.java +++ b/smeem-api/src/main/java/com/smeem/api/diary/api/dto/response/DiaryCreateResponse.java @@ -1,4 +1,4 @@ -package com.smeem.api.diary.controller.dto.response; +package com.smeem.api.diary.api.dto.response; import com.smeem.api.badge.controller.dto.response.AcquiredBadgeResponse; import com.smeem.api.diary.service.dto.response.DiaryCreateServiceResponse; diff --git a/smeem-api/src/main/java/com/smeem/api/diary/controller/dto/response/DiaryGetResponse.java b/smeem-api/src/main/java/com/smeem/api/diary/api/dto/response/DiaryGetResponse.java similarity index 94% rename from smeem-api/src/main/java/com/smeem/api/diary/controller/dto/response/DiaryGetResponse.java rename to smeem-api/src/main/java/com/smeem/api/diary/api/dto/response/DiaryGetResponse.java index 80b27e37..e6984b71 100644 --- a/smeem-api/src/main/java/com/smeem/api/diary/controller/dto/response/DiaryGetResponse.java +++ b/smeem-api/src/main/java/com/smeem/api/diary/api/dto/response/DiaryGetResponse.java @@ -1,4 +1,4 @@ -package com.smeem.api.diary.controller.dto.response; +package com.smeem.api.diary.api.dto.response; import com.smeem.api.diary.service.dto.response.DiaryGetServiceResponse; import com.smeem.common.util.Util; diff --git a/smeem-api/src/main/java/com/smeem/api/diary/controller/dto/response/DiaryListGetResponse.java b/smeem-api/src/main/java/com/smeem/api/diary/api/dto/response/DiaryListGetResponse.java similarity index 96% rename from smeem-api/src/main/java/com/smeem/api/diary/controller/dto/response/DiaryListGetResponse.java rename to smeem-api/src/main/java/com/smeem/api/diary/api/dto/response/DiaryListGetResponse.java index eeaa21b6..6a9f90b9 100644 --- a/smeem-api/src/main/java/com/smeem/api/diary/controller/dto/response/DiaryListGetResponse.java +++ b/smeem-api/src/main/java/com/smeem/api/diary/api/dto/response/DiaryListGetResponse.java @@ -1,4 +1,4 @@ -package com.smeem.api.diary.controller.dto.response; +package com.smeem.api.diary.api.dto.response; import com.smeem.api.diary.service.dto.response.DiaryListGetServiceResponse; import com.smeem.api.diary.service.dto.response.DiaryListGetServiceResponse.DiaryServiceResponse; diff --git a/smeem-api/src/main/java/com/smeem/api/diary/service/dto/request/DiaryCreateServiceRequest.java b/smeem-api/src/main/java/com/smeem/api/diary/service/dto/request/DiaryCreateServiceRequest.java index 9d359cb1..774ab3ae 100644 --- a/smeem-api/src/main/java/com/smeem/api/diary/service/dto/request/DiaryCreateServiceRequest.java +++ b/smeem-api/src/main/java/com/smeem/api/diary/service/dto/request/DiaryCreateServiceRequest.java @@ -1,6 +1,6 @@ package com.smeem.api.diary.service.dto.request; -import com.smeem.api.diary.controller.dto.request.DiaryCreateRequest; +import com.smeem.api.diary.api.dto.request.DiaryCreateRequest; import lombok.Builder; import static lombok.AccessLevel.PRIVATE; diff --git a/smeem-api/src/main/java/com/smeem/api/diary/service/dto/request/DiaryModifyServiceRequest.java b/smeem-api/src/main/java/com/smeem/api/diary/service/dto/request/DiaryModifyServiceRequest.java index 58836b7b..51d4f329 100644 --- a/smeem-api/src/main/java/com/smeem/api/diary/service/dto/request/DiaryModifyServiceRequest.java +++ b/smeem-api/src/main/java/com/smeem/api/diary/service/dto/request/DiaryModifyServiceRequest.java @@ -1,6 +1,6 @@ package com.smeem.api.diary.service.dto.request; -import com.smeem.api.diary.controller.dto.request.DiaryModifyRequest; +import com.smeem.api.diary.api.dto.request.DiaryModifyRequest; import lombok.Builder; import static lombok.AccessLevel.PRIVATE; diff --git a/smeem-api/src/main/java/com/smeem/api/goal/api/GoalApi.java b/smeem-api/src/main/java/com/smeem/api/goal/api/GoalApi.java new file mode 100644 index 00000000..2469f4ba --- /dev/null +++ b/smeem-api/src/main/java/com/smeem/api/goal/api/GoalApi.java @@ -0,0 +1,29 @@ +package com.smeem.api.goal.api; + +import com.smeem.api.common.BaseResponse; +import com.smeem.domain.goal.model.GoalType; +import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.responses.ApiResponse; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.PathVariable; + +public interface GoalApi { + + @Operation( + summary = "목표 전체 목록 조회", + responses = { + @ApiResponse(responseCode = "200", description = "성공"), + @ApiResponse(responseCode = "500", description = "서버 내부 오류") + } + ) + ResponseEntity> getAllGoals(); + + @Operation( + summary = "목표 상세 조회", + responses = { + @ApiResponse(responseCode = "200", description = "성공"), + @ApiResponse(responseCode = "500", description = "서버 내부 오류") + } + ) + ResponseEntity> getGoalByType(@PathVariable GoalType type); +} diff --git a/smeem-api/src/main/java/com/smeem/api/goal/controller/GoalController.java b/smeem-api/src/main/java/com/smeem/api/goal/api/GoalApiController.java similarity index 87% rename from smeem-api/src/main/java/com/smeem/api/goal/controller/GoalController.java rename to smeem-api/src/main/java/com/smeem/api/goal/api/GoalApiController.java index f414b14a..539f7e27 100644 --- a/smeem-api/src/main/java/com/smeem/api/goal/controller/GoalController.java +++ b/smeem-api/src/main/java/com/smeem/api/goal/api/GoalApiController.java @@ -1,10 +1,10 @@ -package com.smeem.api.goal.controller; +package com.smeem.api.goal.api; import com.smeem.api.common.ApiResponseUtil; import com.smeem.api.common.BaseResponse; -import com.smeem.api.goal.controller.dto.response.GoalGetResponse; -import com.smeem.api.goal.controller.dto.response.GoalListGetResponse; +import com.smeem.api.goal.api.dto.response.GoalGetResponse; +import com.smeem.api.goal.api.dto.response.GoalListGetResponse; import com.smeem.api.goal.service.dto.request.GoalGetServiceRequest; import com.smeem.api.goal.service.GoalService; import com.smeem.domain.goal.model.GoalType; @@ -23,7 +23,7 @@ @RestController @RequiredArgsConstructor @RequestMapping("/api/v2/goals") -public class GoalController { +public class GoalApiController implements GoalApi { private final GoalService goalService; diff --git a/smeem-api/src/main/java/com/smeem/api/goal/controller/dto/response/GoalGetResponse.java b/smeem-api/src/main/java/com/smeem/api/goal/api/dto/response/GoalGetResponse.java similarity index 92% rename from smeem-api/src/main/java/com/smeem/api/goal/controller/dto/response/GoalGetResponse.java rename to smeem-api/src/main/java/com/smeem/api/goal/api/dto/response/GoalGetResponse.java index 0c423bca..b45d3320 100644 --- a/smeem-api/src/main/java/com/smeem/api/goal/controller/dto/response/GoalGetResponse.java +++ b/smeem-api/src/main/java/com/smeem/api/goal/api/dto/response/GoalGetResponse.java @@ -1,4 +1,4 @@ -package com.smeem.api.goal.controller.dto.response; +package com.smeem.api.goal.api.dto.response; import com.smeem.api.goal.service.dto.response.GoalGetServiceResponse; import lombok.Builder; diff --git a/smeem-api/src/main/java/com/smeem/api/goal/controller/dto/response/GoalListGetResponse.java b/smeem-api/src/main/java/com/smeem/api/goal/api/dto/response/GoalListGetResponse.java similarity index 95% rename from smeem-api/src/main/java/com/smeem/api/goal/controller/dto/response/GoalListGetResponse.java rename to smeem-api/src/main/java/com/smeem/api/goal/api/dto/response/GoalListGetResponse.java index c6b001ba..119b5546 100644 --- a/smeem-api/src/main/java/com/smeem/api/goal/controller/dto/response/GoalListGetResponse.java +++ b/smeem-api/src/main/java/com/smeem/api/goal/api/dto/response/GoalListGetResponse.java @@ -1,4 +1,4 @@ -package com.smeem.api.goal.controller.dto.response; +package com.smeem.api.goal.api.dto.response; import com.smeem.api.goal.service.dto.response.GoalListGetServiceResponse; import com.smeem.api.goal.service.dto.response.GoalListGetServiceResponse.GoalServiceResponse; diff --git a/smeem-api/src/main/java/com/smeem/api/topic/api/TopicApi.java b/smeem-api/src/main/java/com/smeem/api/topic/api/TopicApi.java new file mode 100644 index 00000000..567efd58 --- /dev/null +++ b/smeem-api/src/main/java/com/smeem/api/topic/api/TopicApi.java @@ -0,0 +1,18 @@ +package com.smeem.api.topic.api; + +import com.smeem.api.common.BaseResponse; +import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.responses.ApiResponse; +import org.springframework.http.ResponseEntity; + +public interface TopicApi { + + @Operation( + summary = "랜덤 주제 조회", + responses = { + @ApiResponse(responseCode = "200", description = "성공"), + @ApiResponse(responseCode = "500", description = "서버 내부 오류") + } + ) + ResponseEntity> getTopicByRandom(); +} diff --git a/smeem-api/src/main/java/com/smeem/api/topic/controller/TopicController.java b/smeem-api/src/main/java/com/smeem/api/topic/api/TopicApiController.java similarity index 85% rename from smeem-api/src/main/java/com/smeem/api/topic/controller/TopicController.java rename to smeem-api/src/main/java/com/smeem/api/topic/api/TopicApiController.java index 187a306d..9a779a44 100644 --- a/smeem-api/src/main/java/com/smeem/api/topic/controller/TopicController.java +++ b/smeem-api/src/main/java/com/smeem/api/topic/api/TopicApiController.java @@ -1,8 +1,8 @@ -package com.smeem.api.topic.controller; +package com.smeem.api.topic.api; import com.smeem.api.common.ApiResponseUtil; import com.smeem.api.common.BaseResponse; -import com.smeem.api.topic.controller.dto.response.RandomTopicGetResponse; +import com.smeem.api.topic.api.dto.response.RandomTopicGetResponse; import com.smeem.api.topic.service.TopicService; import lombok.val; import org.springframework.http.ResponseEntity; @@ -17,7 +17,7 @@ @RestController @RequiredArgsConstructor @RequestMapping("/api/v2/topics") -public class TopicController { +public class TopicApiController implements TopicApi { private final TopicService topicService; diff --git a/smeem-api/src/main/java/com/smeem/api/topic/controller/dto/response/RandomTopicGetResponse.java b/smeem-api/src/main/java/com/smeem/api/topic/api/dto/response/RandomTopicGetResponse.java similarity index 90% rename from smeem-api/src/main/java/com/smeem/api/topic/controller/dto/response/RandomTopicGetResponse.java rename to smeem-api/src/main/java/com/smeem/api/topic/api/dto/response/RandomTopicGetResponse.java index 3b310855..c4afebb8 100644 --- a/smeem-api/src/main/java/com/smeem/api/topic/controller/dto/response/RandomTopicGetResponse.java +++ b/smeem-api/src/main/java/com/smeem/api/topic/api/dto/response/RandomTopicGetResponse.java @@ -1,4 +1,4 @@ -package com.smeem.api.topic.controller.dto.response; +package com.smeem.api.topic.api.dto.response; import com.smeem.api.topic.service.dto.response.RandomTopicGetServiceResponse; import lombok.Builder; diff --git a/smeem-api/src/test/java/com/smeem/api/controller/DiaryControllerTest.java b/smeem-api/src/test/java/com/smeem/api/controller/DiaryControllerTest.java index 6597b78a..0be52f44 100644 --- a/smeem-api/src/test/java/com/smeem/api/controller/DiaryControllerTest.java +++ b/smeem-api/src/test/java/com/smeem/api/controller/DiaryControllerTest.java @@ -5,8 +5,8 @@ //import com.smeem.api.common.ApiResponseUtil; //import com.smeem.api.common.BaseResponse; //import com.smeem.api.diary.controller.DiaryController; -//import com.smeem.api.diary.controller.dto.request.DiaryCreateRequest; -//import com.smeem.api.diary.controller.dto.request.DiaryModifyRequest; +//import com.smeem.api.diary.api.dto.request.DiaryCreateRequest; +//import com.smeem.api.diary.api.dto.request.DiaryModifyRequest; //import com.smeem.api.diary.service.dto.response.DiaryCreateServiceResponse; //import com.smeem.api.diary.service.dto.response.DiaryListGetServiceResponse; //import com.smeem.api.diary.service.dto.response.DiaryGetServiceResponse; From 35f935a58572022c06b81d7054bb592c063b91f7 Mon Sep 17 00:00:00 2001 From: thguss Date: Tue, 12 Mar 2024 23:51:58 +0900 Subject: [PATCH 2/3] =?UTF-8?q?[ADD]=20=EC=8A=A4=EC=9B=A8=EA=B1=B0=20?= =?UTF-8?q?=EC=BB=A8=EB=B2=A4=EC=85=98=20=ED=86=B5=EC=9D=BC=20=EB=B0=98?= =?UTF-8?q?=EC=98=81?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../com/smeem/api/diary/api/DiaryApi.java | 81 +++++++++++-------- .../java/com/smeem/api/goal/api/GoalApi.java | 29 +++---- .../java/com/smeem/api/test/api/TestApi.java | 35 ++++---- .../com/smeem/api/topic/api/TopicApi.java | 21 +++-- 4 files changed, 95 insertions(+), 71 deletions(-) diff --git a/smeem-api/src/main/java/com/smeem/api/diary/api/DiaryApi.java b/smeem-api/src/main/java/com/smeem/api/diary/api/DiaryApi.java index 682d4dd2..d372d45b 100644 --- a/smeem-api/src/main/java/com/smeem/api/diary/api/DiaryApi.java +++ b/smeem-api/src/main/java/com/smeem/api/diary/api/DiaryApi.java @@ -4,7 +4,10 @@ import com.smeem.api.diary.api.dto.request.DiaryCreateRequest; import com.smeem.api.diary.api.dto.request.DiaryModifyRequest; import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.Parameter; 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 org.springframework.http.ResponseEntity; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.RequestBody; @@ -12,51 +15,59 @@ import java.security.Principal; +import static io.swagger.v3.oas.annotations.enums.ParameterIn.HEADER; + +@Tag(name = "[Diary] 일기 관련 API (V2)") public interface DiaryApi { - @Operation( - summary = "일기 생성", - responses = { - @ApiResponse(responseCode = "201", description = "성공"), - @ApiResponse(responseCode = "500", description = "서버 내부 오류") - } - ) + @Operation(summary = "일기 생성 API") + @Parameter(name = "Authorization", description = "Bearer {access_token}", in = HEADER, required = true) + @ApiResponses(value = { + @ApiResponse(responseCode = "201", description = "성공"), + @ApiResponse(responseCode = "4xx", description = "유효하지 않은 요청"), + @ApiResponse(responseCode = "401", description = "유효하지 않은 토큰"), + @ApiResponse(responseCode = "500", description = "서버 내부 오류") + }) ResponseEntity> createDiary(Principal principal, @RequestBody DiaryCreateRequest request); - @Operation( - summary = "일기 상세 조회", - responses = { - @ApiResponse(responseCode = "200", description = "성공"), - @ApiResponse(responseCode = "500", description = "서버 내부 오류") - } - ) + @Operation(summary = "일기 상세 조회 API") + @Parameter(name = "Authorization", description = "Bearer {access_token}", in = HEADER, required = true) + @ApiResponses(value = { + @ApiResponse(responseCode = "200", description = "성공"), + @ApiResponse(responseCode = "4xx", description = "유효하지 않은 요청"), + @ApiResponse(responseCode = "401", description = "유효하지 않은 토큰"), + @ApiResponse(responseCode = "500", description = "서버 내부 오류") + }) ResponseEntity> getDiaryDetail(@PathVariable long diaryId); - @Operation( - summary = "일기 수정", - responses = { - @ApiResponse(responseCode = "200", description = "성공"), - @ApiResponse(responseCode = "500", description = "서버 내부 오류") - } - ) + @Operation(summary = "일기 수정 API") + @Parameter(name = "Authorization", description = "Bearer {access_token}", in = HEADER, required = true) + @ApiResponses(value = { + @ApiResponse(responseCode = "200", description = "성공"), + @ApiResponse(responseCode = "4xx", description = "유효하지 않은 요청"), + @ApiResponse(responseCode = "401", description = "유효하지 않은 토큰"), + @ApiResponse(responseCode = "500", description = "서버 내부 오류") + }) ResponseEntity> modifyDiary(@PathVariable long diaryId, @RequestBody DiaryModifyRequest request); - @Operation( - summary = "일기 삭제", - responses = { - @ApiResponse(responseCode = "200", description = "성공"), - @ApiResponse(responseCode = "500", description = "서버 내부 오류") - } - ) + @Operation(summary = "일기 삭제 API") + @Parameter(name = "Authorization", description = "Bearer {access_token}", in = HEADER, required = true) + @ApiResponses(value = { + @ApiResponse(responseCode = "200", description = "성공"), + @ApiResponse(responseCode = "4xx", description = "유효하지 않은 요청"), + @ApiResponse(responseCode = "401", description = "유효하지 않은 토큰"), + @ApiResponse(responseCode = "500", description = "서버 내부 오류") + }) ResponseEntity> deleteDiary(@PathVariable long diaryId); - @Operation( - summary = "기간 내 일기 목록 조회", - responses = { - @ApiResponse(responseCode = "200", description = "성공"), - @ApiResponse(responseCode = "500", description = "서버 내부 오류") - } - ) + @Operation(summary = "기간 내 일기 목록 조회 API") + @Parameter(name = "Authorization", description = "Bearer {access_token}", in = HEADER, required = true) + @ApiResponses(value = { + @ApiResponse(responseCode = "200", description = "성공"), + @ApiResponse(responseCode = "4xx", description = "유효하지 않은 요청"), + @ApiResponse(responseCode = "401", description = "유효하지 않은 토큰"), + @ApiResponse(responseCode = "500", description = "서버 내부 오류") + }) ResponseEntity> getDiaries( Principal principal, @RequestParam String start, diff --git a/smeem-api/src/main/java/com/smeem/api/goal/api/GoalApi.java b/smeem-api/src/main/java/com/smeem/api/goal/api/GoalApi.java index 2469f4ba..830965c0 100644 --- a/smeem-api/src/main/java/com/smeem/api/goal/api/GoalApi.java +++ b/smeem-api/src/main/java/com/smeem/api/goal/api/GoalApi.java @@ -4,26 +4,27 @@ import com.smeem.domain.goal.model.GoalType; 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; import org.springframework.http.ResponseEntity; import org.springframework.web.bind.annotation.PathVariable; +@Tag(name = "[Goal] 목표 관련 API (V2)") public interface GoalApi { - @Operation( - summary = "목표 전체 목록 조회", - responses = { - @ApiResponse(responseCode = "200", description = "성공"), - @ApiResponse(responseCode = "500", description = "서버 내부 오류") - } - ) + @Operation(summary = "목표 전체 목록 조회 API") + @ApiResponses(value = { + @ApiResponse(responseCode = "200", description = "성공"), + @ApiResponse(responseCode = "4xx", description = "유효하지 않은 요청"), + @ApiResponse(responseCode = "500", description = "서버 내부 오류") + }) ResponseEntity> getAllGoals(); - @Operation( - summary = "목표 상세 조회", - responses = { - @ApiResponse(responseCode = "200", description = "성공"), - @ApiResponse(responseCode = "500", description = "서버 내부 오류") - } - ) + @Operation(summary = "목표 상세 조회 API") + @ApiResponses(value = { + @ApiResponse(responseCode = "200", description = "성공"), + @ApiResponse(responseCode = "4xx", description = "유효하지 않은 요청"), + @ApiResponse(responseCode = "500", description = "서버 내부 오류") + }) ResponseEntity> getGoalByType(@PathVariable GoalType type); } diff --git a/smeem-api/src/main/java/com/smeem/api/test/api/TestApi.java b/smeem-api/src/main/java/com/smeem/api/test/api/TestApi.java index 2586784f..c473b81a 100644 --- a/smeem-api/src/main/java/com/smeem/api/test/api/TestApi.java +++ b/smeem-api/src/main/java/com/smeem/api/test/api/TestApi.java @@ -2,29 +2,34 @@ import com.smeem.api.common.BaseResponse; import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.Parameter; 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 org.springframework.http.ResponseEntity; import java.security.Principal; +import static io.swagger.v3.oas.annotations.enums.ParameterIn.HEADER; + +@Tag(name = "[Test] 테스트 관련 API (V2)") public interface TestApi { - @Operation( - summary = "서버 연결 테스트", - responses = { - @ApiResponse(responseCode = "200", description = "성공"), - @ApiResponse(responseCode = "500", description = "서버 내부 오류") - } - ) + @Operation(summary = "서버 연결 테스트 API") + @ApiResponses(value = { + @ApiResponse(responseCode = "200", description = "성공"), + @ApiResponse(responseCode = "4xx", description = "유효하지 않은 요청"), + @ApiResponse(responseCode = "500", description = "서버 내부 오류") + }) ResponseEntity> test(); - @Operation( - summary = "푸시알림 테스트", - responses = { - @ApiResponse(responseCode = "200", description = "성공"), - @ApiResponse(responseCode = "401", description = "유효하지 않은 토큰"), - @ApiResponse(responseCode = "500", description = "서버 내부 오류") - } - ) + @Operation(summary = "푸시알림 테스트 API") + @Parameter(name = "Authorization", description = "Bearer {access_token}", in = HEADER, required = true) + @ApiResponses(value = { + @ApiResponse(responseCode = "200", description = "성공"), + @ApiResponse(responseCode = "4xx", description = "유효하지 않은 요청"), + @ApiResponse(responseCode = "401", description = "유효하지 않은 토큰"), + @ApiResponse(responseCode = "500", description = "서버 내부 오류") + }) ResponseEntity> alarmTest(Principal principal); } diff --git a/smeem-api/src/main/java/com/smeem/api/topic/api/TopicApi.java b/smeem-api/src/main/java/com/smeem/api/topic/api/TopicApi.java index 567efd58..274c8c6b 100644 --- a/smeem-api/src/main/java/com/smeem/api/topic/api/TopicApi.java +++ b/smeem-api/src/main/java/com/smeem/api/topic/api/TopicApi.java @@ -2,17 +2,24 @@ import com.smeem.api.common.BaseResponse; import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.Parameter; 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 org.springframework.http.ResponseEntity; +import static io.swagger.v3.oas.annotations.enums.ParameterIn.HEADER; + +@Tag(name = "[Topic] 주제 관련 API (V2)") public interface TopicApi { - @Operation( - summary = "랜덤 주제 조회", - responses = { - @ApiResponse(responseCode = "200", description = "성공"), - @ApiResponse(responseCode = "500", description = "서버 내부 오류") - } - ) + @Operation(summary = "랜덤 주제 조회 API") + @Parameter(name = "Authorization", description = "Bearer {access_token}", in = HEADER, required = true) + @ApiResponses(value = { + @ApiResponse(responseCode = "200", description = "성공"), + @ApiResponse(responseCode = "4xx", description = "유효하지 않은 요청"), + @ApiResponse(responseCode = "401", description = "유효하지 않은 토큰"), + @ApiResponse(responseCode = "500", description = "서버 내부 오류") + }) ResponseEntity> getTopicByRandom(); } From 09c77b68b0c2fae3c23b79fd0c90cfec76ed714f Mon Sep 17 00:00:00 2001 From: thguss Date: Wed, 13 Mar 2024 00:09:02 +0900 Subject: [PATCH 3/3] =?UTF-8?q?[FIX]=20=ED=86=A0=ED=81=B0=20=ED=95=84?= =?UTF-8?q?=EB=93=9C=EB=AA=85=20=ED=86=B5=EC=9D=BC=20=EB=B0=98=EC=98=81?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../main/java/com/smeem/api/diary/api/DiaryApi.java | 10 +++++----- .../src/main/java/com/smeem/api/test/api/TestApi.java | 2 +- .../main/java/com/smeem/api/topic/api/TopicApi.java | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/smeem-api/src/main/java/com/smeem/api/diary/api/DiaryApi.java b/smeem-api/src/main/java/com/smeem/api/diary/api/DiaryApi.java index d372d45b..c222892d 100644 --- a/smeem-api/src/main/java/com/smeem/api/diary/api/DiaryApi.java +++ b/smeem-api/src/main/java/com/smeem/api/diary/api/DiaryApi.java @@ -21,7 +21,7 @@ public interface DiaryApi { @Operation(summary = "일기 생성 API") - @Parameter(name = "Authorization", description = "Bearer {access_token}", in = HEADER, required = true) + @Parameter(name = "Authorization", description = "Bearer ${Smeem Access Token}", in = HEADER, required = true) @ApiResponses(value = { @ApiResponse(responseCode = "201", description = "성공"), @ApiResponse(responseCode = "4xx", description = "유효하지 않은 요청"), @@ -31,7 +31,7 @@ public interface DiaryApi { ResponseEntity> createDiary(Principal principal, @RequestBody DiaryCreateRequest request); @Operation(summary = "일기 상세 조회 API") - @Parameter(name = "Authorization", description = "Bearer {access_token}", in = HEADER, required = true) + @Parameter(name = "Authorization", description = "Bearer ${Smeem Access Token}", in = HEADER, required = true) @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "성공"), @ApiResponse(responseCode = "4xx", description = "유효하지 않은 요청"), @@ -41,7 +41,7 @@ public interface DiaryApi { ResponseEntity> getDiaryDetail(@PathVariable long diaryId); @Operation(summary = "일기 수정 API") - @Parameter(name = "Authorization", description = "Bearer {access_token}", in = HEADER, required = true) + @Parameter(name = "Authorization", description = "Bearer ${Smeem Access Token}", in = HEADER, required = true) @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "성공"), @ApiResponse(responseCode = "4xx", description = "유효하지 않은 요청"), @@ -51,7 +51,7 @@ public interface DiaryApi { ResponseEntity> modifyDiary(@PathVariable long diaryId, @RequestBody DiaryModifyRequest request); @Operation(summary = "일기 삭제 API") - @Parameter(name = "Authorization", description = "Bearer {access_token}", in = HEADER, required = true) + @Parameter(name = "Authorization", description = "Bearer ${Smeem Access Token}", in = HEADER, required = true) @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "성공"), @ApiResponse(responseCode = "4xx", description = "유효하지 않은 요청"), @@ -61,7 +61,7 @@ public interface DiaryApi { ResponseEntity> deleteDiary(@PathVariable long diaryId); @Operation(summary = "기간 내 일기 목록 조회 API") - @Parameter(name = "Authorization", description = "Bearer {access_token}", in = HEADER, required = true) + @Parameter(name = "Authorization", description = "Bearer ${Smeem Access Token}", in = HEADER, required = true) @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "성공"), @ApiResponse(responseCode = "4xx", description = "유효하지 않은 요청"), diff --git a/smeem-api/src/main/java/com/smeem/api/test/api/TestApi.java b/smeem-api/src/main/java/com/smeem/api/test/api/TestApi.java index c473b81a..a0af99d1 100644 --- a/smeem-api/src/main/java/com/smeem/api/test/api/TestApi.java +++ b/smeem-api/src/main/java/com/smeem/api/test/api/TestApi.java @@ -24,7 +24,7 @@ public interface TestApi { ResponseEntity> test(); @Operation(summary = "푸시알림 테스트 API") - @Parameter(name = "Authorization", description = "Bearer {access_token}", in = HEADER, required = true) + @Parameter(name = "Authorization", description = "Bearer ${Smeem Access Token}", in = HEADER, required = true) @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "성공"), @ApiResponse(responseCode = "4xx", description = "유효하지 않은 요청"), diff --git a/smeem-api/src/main/java/com/smeem/api/topic/api/TopicApi.java b/smeem-api/src/main/java/com/smeem/api/topic/api/TopicApi.java index 274c8c6b..84351294 100644 --- a/smeem-api/src/main/java/com/smeem/api/topic/api/TopicApi.java +++ b/smeem-api/src/main/java/com/smeem/api/topic/api/TopicApi.java @@ -14,7 +14,7 @@ public interface TopicApi { @Operation(summary = "랜덤 주제 조회 API") - @Parameter(name = "Authorization", description = "Bearer {access_token}", in = HEADER, required = true) + @Parameter(name = "Authorization", description = "Bearer ${Smeem Access Token}", in = HEADER, required = true) @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "성공"), @ApiResponse(responseCode = "4xx", description = "유효하지 않은 요청"),