diff --git a/src/main/java/com/teaching/backend/domain/home/controller/HomeController.java b/src/main/java/com/teaching/backend/domain/home/controller/HomeController.java index 4300a56..62af3bb 100644 --- a/src/main/java/com/teaching/backend/domain/home/controller/HomeController.java +++ b/src/main/java/com/teaching/backend/domain/home/controller/HomeController.java @@ -7,6 +7,7 @@ import com.teaching.backend.global.exception.GeneralException; import com.teaching.backend.global.response.ApiResponse; import com.teaching.backend.global.security.entity.AuthMember; +import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.tags.Tag; import lombok.RequiredArgsConstructor; import org.springframework.http.ResponseEntity; @@ -23,6 +24,10 @@ public class HomeController { private final HomeService homeService; + @Operation( + summary = "홈 화면 조회", + description = "최근 완료 자료 5개와 진행 중인 티칭맵 3개를 조회합니다." + ) @GetMapping public ResponseEntity> getDashboard( @AuthenticationPrincipal AuthMember authMember diff --git a/src/main/java/com/teaching/backend/domain/material/controller/MaterialController.java b/src/main/java/com/teaching/backend/domain/material/controller/MaterialController.java index a1aee7d..083c4fd 100644 --- a/src/main/java/com/teaching/backend/domain/material/controller/MaterialController.java +++ b/src/main/java/com/teaching/backend/domain/material/controller/MaterialController.java @@ -32,6 +32,10 @@ public class MaterialController { private final MaterialIndexingService materialIndexingService; private final MaterialService materialService; + @Operation( + summary = "최근 수집 자료 조회", + description = "삭제되지 않은 수집 자료를 생성일 최신순으로 조회하며, size가 지정된 경우 해당 개수만 반환합니다." + ) @GetMapping public ResponseEntity>> getMaterials( @AuthenticationPrincipal AuthMember authMember, diff --git a/src/main/java/com/teaching/backend/domain/notification/controller/NotificationController.java b/src/main/java/com/teaching/backend/domain/notification/controller/NotificationController.java index 3315375..bee2d25 100644 --- a/src/main/java/com/teaching/backend/domain/notification/controller/NotificationController.java +++ b/src/main/java/com/teaching/backend/domain/notification/controller/NotificationController.java @@ -9,6 +9,7 @@ import com.teaching.backend.global.exception.GeneralException; import com.teaching.backend.global.response.ApiResponse; import com.teaching.backend.global.security.entity.AuthMember; +import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.tags.Tag; import lombok.RequiredArgsConstructor; import org.springframework.http.ResponseEntity; @@ -30,6 +31,10 @@ public class NotificationController { private final NotificationService notificationService; + @Operation( + summary = "알림 목록 조회", + description = "최근 30일 알림을 읽지 않은 알림 우선, 최신순으로 size만큼 조회합니다." + ) @GetMapping public ResponseEntity>> getNotifications( @AuthenticationPrincipal AuthMember authMember, @@ -45,6 +50,10 @@ public ResponseEntity>> getNotificati ); } + @Operation( + summary = "알림 요약 조회", + description = "최근 30일 내 읽지 않은 알림 존재 여부와 개수를 조회합니다." + ) @GetMapping("/summary") public ResponseEntity> getNotificationSummary( @AuthenticationPrincipal AuthMember authMember @@ -58,6 +67,10 @@ public ResponseEntity> getNotificationS ); } + @Operation( + summary = "알림 읽음 처리", + description = "특정 알림을 읽음 상태로 변경합니다." + ) @PatchMapping("/{notificationId}/read") public ResponseEntity> markAsRead( @AuthenticationPrincipal AuthMember authMember,