[m00nsh]

✨ 어떤 이유로 PR를 하셨나요?

• feature 병합
• 버그 수정(아래에 issue #를 남겨주세요)
• 코드 개선
• 코드 수정
• 배포
• 기타(아래에 자세한 내용 기입해주세요)

📋 세부 내용 - 왜 해당 PR이 필요한지 작업 내용을 자세하게 설명해주세요

작업 내용

Swagger 문서에서 일부 API의 기능을 바로 확인할 수 있도록
@Operation의 summary 및 description을 추가했습니다.

대상 API

• GET /materials

  • 최근 수집 자료 조회
  • 삭제되지 않은 수집 자료를 생성일 최신순으로 조회하며, size가 지정된 경우 해당 개수만 반환

• GET /api/v1/home

  • 홈 화면 조회
  • 최근 완료 자료 5개와 진행 중인 티칭맵 3개 조회

• PATCH /api/v1/notifications/{notificationId}/read

  • 알림 읽음 처리
  • 특정 알림을 읽음 상태로 변경

• GET /api/v1/notifications

  • 알림 목록 조회
  • 최근 30일 알림을 읽지 않은 알림 우선, 최신순으로 size만큼 조회

• GET /api/v1/notifications/summary

  • 알림 요약 조회
  • 최근 30일 내 읽지 않은 알림 존재 여부와 개수 조회

검증

• compileTestJava 통과
• Home / Material / Notification 관련 테스트 통과
• clean build -x test 통과
• git diff --check 통과
• 변경 파일은 관련 Controller 3개로 한정

📸 작업 화면 스크린샷

⚠️ PR하기 전에 확인해주세요

• 로컬테스트를 진행하셨나요?
• 머지할 브랜치를 확인하셨나요?
• 관련 label을 선택하셨나요?

🚨 관련 이슈 번호 [ ]

Summary by CodeRabbit

• 문서화
  • 홈 화면 조회 API의 요약과 설명을 Swagger 문서에 추가했습니다.
  • 자료 목록 조회 API의 조회 기준과 반환 범위를 문서화했습니다.
  • 알림 목록 조회, 요약 조회, 읽음 처리 API의 설명을 보완했습니다.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 5d3773de-e659-47a8-b2a8-e4d8c3a16eef

📥 Commits

Reviewing files that changed from the base of the PR and between 9d54796 and 8fb1f21.

📒 Files selected for processing (3)

• src/main/java/com/teaching/backend/domain/home/controller/HomeController.java
• src/main/java/com/teaching/backend/domain/material/controller/MaterialController.java
• src/main/java/com/teaching/backend/domain/notification/controller/NotificationController.java

---

📝 Walkthrough

Walkthrough

홈, 자료, 알림 컨트롤러의 API에 Swagger @Operation 메타데이터를 추가했습니다. 각 엔드포인트의 요약과 조회·처리 동작을 문서화했으며, 실행 로직과 공개 메서드 시그니처는 변경하지 않았습니다.

Changes

API 문서화

Layer / File(s)	Summary
홈 및 자료 API 문서화 src/main/java/com/teaching/backend/domain/home/controller/HomeController.java, src/main/java/com/teaching/backend/domain/material/controller/MaterialController.java	홈 대시보드 조회와 자료 목록 조회 엔드포인트에 Swagger 설명을 추가했습니다. 자료 조회의 정렬 기준과 size 제한을 문서화했습니다.
알림 API 문서화 src/main/java/com/teaching/backend/domain/notification/controller/NotificationController.java	알림 목록 조회, 최근 30일 내 읽지 않은 알림 요약 조회, 특정 알림 읽음 처리 엔드포인트에 Swagger 설명을 추가했습니다.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

• TeachING-Dev/Backend#33: 다른 컨트롤러의 API에 Swagger @Operation 문서를 추가합니다.
• TeachING-Dev/Backend#36: 동일한 홈, 자료, 알림 API에 Swagger @Operation 문서를 추가합니다.
• TeachING-Dev/Backend#39: 동일한 HomeController와 NotificationController에 Swagger @Tag 문서를 추가합니다.

Suggested labels: documentation

Suggested reviewers: mymyseoyoung

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	제목은 홈·자료·알림 API에 Swagger 설명을 추가한 주요 변경 사항을 정확하고 간결하게 요약합니다.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/swagger-api-descriptions

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[Mymyseoyoung]

Swagger 설명 꼼꼼하게 추가해주셨네요. summary/description 구분도 명확하고 읽기 편한 것 같습니다 !