Merge pull request #73 from Happy-HOBAK/docs/#72

[#72] Swagger에서 API 설명을 위한 애너테이션 추가

src/main/java/com/hobak/happinessql/domain/activity/api/ActivityController.java

@@ -4,9 +4,12 @@
 import com.hobak.happinessql.domain.activity.converter.ActivityConverter;
 import com.hobak.happinessql.domain.activity.dto.*;
 import com.hobak.happinessql.global.response.DataResponseDto;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import lombok.RequiredArgsConstructor;
 import org.springframework.web.bind.annotation.*;
 
+@Tag(name="Activity", description = "활동 관련 REST API에 대한 명세를 제공합니다.")
 @RestController
 @RequestMapping("/api/activities")
 @RequiredArgsConstructor
@@ -17,27 +20,37 @@ public class ActivityController {
     private final ActivityDeleteService activityDeleteService;
     private final ActivityUpdateService activityUpdateService;
     private final ActivitySearchService activitySearchService;
+
+    @Operation(summary = "활동 리스트 조회", description = "유저가 가지고 있는 활동 목록을 조회합니다. 행복 기록 생성 시 활동 선택 창에서 사용하는 API입니다.")
     @GetMapping
     public DataResponseDto<ActivityListResponseDto> getActivities(@RequestParam Long userId) {
         ActivityListResponseDto response = activityListService.getActivities(userId);
         return DataResponseDto.of(response, "사용자의 모든 카테고리별 활동을 성공적으로 조회했습니다.");
     }
+
+    @Operation(summary = "활동 추가", description = "기타 카테고리에 활동을 추가합니다.")
     @PostMapping
     public DataResponseDto<ActivityResponseDto> createActivity(@RequestBody ActivityCreateRequestDto requestDto, @RequestParam Long userId){
         ActivityResponseDto responseDto = activityCreateService.createActivity(requestDto,userId);
         return DataResponseDto.of(responseDto,"활동을 성공적으로 추가했습니다.");
     }
+
+    @Operation(summary = "활동 삭제", description = "기타 카테고리에 있는 활동을 삭제합니다.")
     @DeleteMapping("/{activityId}")
     public DataResponseDto<ActivityResponseDto> deleteActivity(@PathVariable Long activityId){
         activityDeleteService.deleteActivity(activityId);
         ActivityResponseDto responseDto = ActivityConverter.toActivityResponseDto(activityId);
         return DataResponseDto.of(responseDto, "활동을 성공적으로 삭제했습니다.");
     }
+
+    @Operation(summary = "활동 수정", description = "기타 카테고리에 있는 활동을 수정합니다.")
     @PutMapping("/{activityId}")
     public DataResponseDto<ActivityUpdateResponseDto> updateActicity(@PathVariable Long activityId, @RequestBody ActivityUpdateRequestDto requestDto){
         ActivityUpdateResponseDto responseDto = activityUpdateService.updateActivity(activityId,requestDto);
         return DataResponseDto.of(responseDto,"활동을 성공적으로 수정했습니다.");
     }
+
+    @Operation(summary = "활동 추가", description = "유저가 갖고 있는 활동을 검색합니다. (활동의 description에 있는 내용은 아직 검색되지 않습니다.)")
     @PostMapping("/search")
     public DataResponseDto<ActivitySearchResponseDto> searchActivities(@RequestBody ActivitySearchRequestDto requestDto, @RequestParam Long userId) {
         ActivitySearchResponseDto responseDto = activitySearchService.searchActivities(requestDto.getSearch(), userId);

src/main/java/com/hobak/happinessql/domain/record/api/RecordController.java

@@ -11,6 +11,9 @@
 import com.hobak.happinessql.domain.user.domain.User;
 import com.hobak.happinessql.domain.user.repository.UserRepository;
 import com.hobak.happinessql.global.response.DataResponseDto;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.validation.Valid;
 import lombok.RequiredArgsConstructor;
 import org.springframework.http.MediaType;
@@ -19,6 +22,7 @@
 
 import java.util.List;
 
+@Tag(name="Record", description = "행복기록 관련 REST API에 대한 명세를 제공합니다.")
 @RestController
 @RequiredArgsConstructor
 @RequestMapping("api/records")
@@ -28,7 +32,7 @@ public class RecordController {
     private final RecordPagingService recordPagingService;
     private final UserRepository userRepository;
 
-
+    @Operation(summary = "행복 기록 추가", description = "행복 기록을 생성합니다.")
     @PostMapping(consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
     public DataResponseDto<Object> createRecord(
             @Valid @RequestPart(value="content") RecordCreateRequestDto requestDto,
@@ -54,6 +58,10 @@ public DataResponseDto<Object> createRecord(
         return DataResponseDto.of(recordCreationResponseDto, "행복 기록이 저장되었습니다.");
     }
 
+    @Operation(summary = "행복 톺아보기", description = "유저가 갖고 있는 행복 기록을 무한 스크롤 방식으로 조회합니다.",
+            parameters = {@Parameter(name="lastRecordId", description="현재까지 페이지에 그려진 게시물 id 중 가장 작은 값 (최신순이므로 아래로 내려갈수록 id값이 적어집니다.)"),
+                    @Parameter(name="size", description = "한 번에 가져올 레코드의 개수")
+    })
     @GetMapping
     public DataResponseDto<Object> getRecordList(@RequestParam Long lastRecordId, @RequestParam int size) {
         // TODO : 임시값 -> 로그인한 유저의 id를 찾아내는 로직으로 변경

src/main/java/com/hobak/happinessql/domain/user/api/UserController.java

@@ -7,10 +7,13 @@
 import com.hobak.happinessql.domain.user.dto.UserInfoResponseDto;
 import com.hobak.happinessql.domain.user.dto.UserProfileUpdateRequestDto;
 import com.hobak.happinessql.global.response.DataResponseDto;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.validation.Valid;
 import lombok.RequiredArgsConstructor;
 import org.springframework.web.bind.annotation.*;
 
+@Tag(name="User", description = "유저 관련 REST API에 대한 명세를 제공합니다.")
 @RestController
 @RequiredArgsConstructor
 @RequestMapping("api/users")
@@ -19,6 +22,7 @@ public class UserController {
     private final UserFindService userFindService;
     private final UserProfileService userProfileService;
 
+    @Operation(summary = "프로필 조회", description = "유저의 프로필을 조회합니다.")
     @GetMapping("/profile")
     public DataResponseDto<Object> getUserInfo() {
         // TODO : 임시값 -> 로그인한 유저의 id를 찾아내는 로직으로 변경
@@ -30,6 +34,7 @@ public DataResponseDto<Object> getUserInfo() {
         return DataResponseDto.of(userInfoResponseDto, "유저 프로필을 성공적으로 조회했습니다.");
     }
 
+    @Operation(summary = "프로필 수정", description = "유저의 프로필을 수정합니다. 성별과 나이만 수정이 가능합니다.")
     @PutMapping("/profile")
     public DataResponseDto<Object> updateUserInfo(@RequestBody @Valid UserProfileUpdateRequestDto requestDto) {
         Long userId = 1L;