[REFACTOR] 스웨거 이사

smeem-api/src/main/java/com/smeem/api/diary/api/DiaryApi.java

@@ -0,0 +1,76 @@
+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.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;
+import org.springframework.web.bind.annotation.RequestParam;
+
+import java.security.Principal;
+
+import static io.swagger.v3.oas.annotations.enums.ParameterIn.HEADER;
+
+@Tag(name = "[Diary] 일기 관련 API (V2)")
+public interface DiaryApi {
+
+    @Operation(summary = "일기 생성 API")
+    @Parameter(name = "Authorization", description = "Bearer ${Smeem 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<BaseResponse<?>> createDiary(Principal principal, @RequestBody DiaryCreateRequest request);
+
+    @Operation(summary = "일기 상세 조회 API")
+    @Parameter(name = "Authorization", description = "Bearer ${Smeem 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<BaseResponse<?>> getDiaryDetail(@PathVariable long diaryId);
+
+    @Operation(summary = "일기 수정 API")
+    @Parameter(name = "Authorization", description = "Bearer ${Smeem 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<BaseResponse<?>> modifyDiary(@PathVariable long diaryId, @RequestBody DiaryModifyRequest request);
+
+    @Operation(summary = "일기 삭제 API")
+    @Parameter(name = "Authorization", description = "Bearer ${Smeem 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<BaseResponse<?>> deleteDiary(@PathVariable long diaryId);
+
+    @Operation(summary = "기간 내 일기 목록 조회 API")
+    @Parameter(name = "Authorization", description = "Bearer ${Smeem 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<BaseResponse<?>> getDiaries(
+            Principal principal,
+            @RequestParam String start,
+            @RequestParam String end
+    );
+}

smeem-api/src/main/java/com/smeem/api/diary/controller/DiaryController.java → 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;

smeem-api/src/main/java/com/smeem/api/diary/controller/dto/request/DiaryCreateRequest.java → 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;
 

smeem-api/src/main/java/com/smeem/api/diary/controller/dto/request/DiaryModifyRequest.java → 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;
 

smeem-api/src/main/java/com/smeem/api/diary/controller/dto/response/DiaryCreateResponse.java → 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;

smeem-api/src/main/java/com/smeem/api/diary/controller/dto/response/DiaryGetResponse.java → 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;

smeem-api/src/main/java/com/smeem/api/diary/controller/dto/response/DiaryListGetResponse.java → 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;

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;

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;

smeem-api/src/main/java/com/smeem/api/goal/api/GoalApi.java

@@ -0,0 +1,30 @@
+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 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 = "목표 전체 목록 조회 API")
+    @ApiResponses(value = {
+            @ApiResponse(responseCode = "200", description = "성공"),
+            @ApiResponse(responseCode = "4xx", description = "유효하지 않은 요청"),
+            @ApiResponse(responseCode = "500", description = "서버 내부 오류")
+    })
+    ResponseEntity<BaseResponse<?>> getAllGoals();
+
+    @Operation(summary = "목표 상세 조회 API")
+    @ApiResponses(value = {
+            @ApiResponse(responseCode = "200", description = "성공"),
+            @ApiResponse(responseCode = "4xx", description = "유효하지 않은 요청"),
+            @ApiResponse(responseCode = "500", description = "서버 내부 오류")
+    })
+    ResponseEntity<BaseResponse<?>> getGoalByType(@PathVariable GoalType type);
+}

smeem-api/src/main/java/com/smeem/api/goal/controller/GoalController.java → 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;
 

smeem-api/src/main/java/com/smeem/api/goal/controller/dto/response/GoalGetResponse.java → 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;

smeem-api/src/main/java/com/smeem/api/goal/controller/dto/response/GoalListGetResponse.java → 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;

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<BaseResponse<?>> test();
 
-    @Operation(
-            summary = "푸시알림 테스트",
-            responses = {
-                    @ApiResponse(responseCode = "200", description = "성공"),
-                    @ApiResponse(responseCode = "401", description = "유효하지 않은 토큰"),
-                    @ApiResponse(responseCode = "500", description = "서버 내부 오류")
-            }
-    )
+    @Operation(summary = "푸시알림 테스트 API")
+    @Parameter(name = "Authorization", description = "Bearer ${Smeem 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<BaseResponse<?>> alarmTest(Principal principal);
 }

smeem-api/src/main/java/com/smeem/api/topic/api/TopicApi.java

@@ -0,0 +1,25 @@
+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.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 = "랜덤 주제 조회 API")
+    @Parameter(name = "Authorization", description = "Bearer ${Smeem 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<BaseResponse<?>> getTopicByRandom();
+}

smeem-api/src/main/java/com/smeem/api/topic/controller/TopicController.java → 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;
 

smeem-api/src/main/java/com/smeem/api/topic/controller/dto/response/RandomTopicGetResponse.java → 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;

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;