[REFACTOR] Swagger 문서 형식 통일 (학습/사용자)

[p1001q]

📍 개요

담당 도메인의 스웨거 문서를 컨벤션에 맞춰 수정

⛓️‍💥 관련 이슈

• ♻️ Refactor - Swagger API 문서 형식 통일 #200

---

🛠️ 작업 내용

• 학습, 사용자 도메인 Swagger 문서 형식 통일 (Tag name 한글화, description "@@ API" 통일, summary 끝에 " API" 추가)
• 사용자 도메인 Tag를 "사용자 프로필"/"사용자" 둘로 나누지 않고 "사용자" 하나로 통합
  ㄴ 사용자에 닉네임 중복 확인 api 하나만 존재해서 보기 편하게 큰 범위인 사용자 도메인에 사용자 프로필도 통합시켰어요~

---

🔥 리뷰 요청 사항

리뷰어가 중점적으로 확인해주었으면 하는 내용을 작성해주세요.

• 컨벤션에 맞는지
• 사용자 프로필/사용자 Tag를 하나로 합친 것 괜찮은지

---

✅ 체크리스트

• 코드 컨벤션을 준수했습니다.
• 불필요한 코드 및 import를 제거했습니다.
• 예외 처리를 적용했습니다.
• 테스트를 완료했습니다.
• 관련 Issue를 연결했습니다.

---

📎 참고 사항

학습 도메인에 남아있는 불필요한 주석 등은 이번 PR 범위에서 정리하지 않았습니다.
별도로 열려있는 #168(학습 도메인 리팩토링)에서 정리할 예정입니다~

Summary by CodeRabbit

• 문서
  • 학습, 사용자, 사용자 프로필 API의 Swagger 태그와 요약 문구를 보다 명확하게 정비했습니다.
  • 일부 API 설명에 ‘API’ 및 ‘전체보기’ 표현을 추가해 문서 가독성을 개선했습니다.
  • API 동작, 경로 및 응답에는 변경 사항이 없습니다.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: e029eb49-e050-451c-af38-88c06c4a34a2

📥 Commits

Reviewing files that changed from the base of the PR and between a8b11ad and ea22207.

📒 Files selected for processing (3)

• src/main/java/com/mr/domain/learning/controller/LearningController.java
• src/main/java/com/mr/domain/user/controller/UserController.java
• src/main/java/com/mr/domain/user/controller/UserProfileController.java

---

📝 Walkthrough

Walkthrough

학습 및 사용자 컨트롤러의 Swagger 태그와 API 요약 문구를 표준화했습니다. API 경로, 파라미터, 반환 타입, 서비스 호출 흐름은 변경하지 않았습니다.

Changes

Swagger API 문서 표준화

Layer / File(s)	Summary
컨트롤러 Swagger 문구 수정 src/main/java/com/mr/domain/learning/controller/LearningController.java, src/main/java/com/mr/domain/user/controller/UserController.java, src/main/java/com/mr/domain/user/controller/UserProfileController.java	학습 및 사용자 컨트롤러의 @Tag와 @Operation 요약 문구에 API를 반영했습니다. 일부 학습 요약에서 THEORY, ACCOMPANIMENT 표기를 제거했습니다. 실행 로직은 변경하지 않았습니다.

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

Possibly related PRs

• Musereview/BE#203: 도메인 컨트롤러의 Swagger 태그와 @Operation 요약 문구를 함께 표준화했습니다.
• Musereview/BE#104: UserController.java의 닉네임 중복 확인 API Swagger 설명을 수정했습니다.
• Musereview/BE#50: LearningController의 Swagger 문서와 학습 조회 엔드포인트를 다뤘습니다.

Poem

태그는 짧게, API는 또렷하게
학습 문구는 한결같게
사용자 설명도 정돈되어
Swagger 화면에 빛이 나네
동작은 그대로, 문서만 산뜻하게 ✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
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.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	제목은 학습 및 사용자 도메인의 Swagger 문서 형식 통일이라는 주요 변경 사항을 정확하고 간결하게 설명합니다.

✨ 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 refactor/#200-swagger-convention-sy

---

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.}

[ownue]

필요한 부분만 적절히 수정하셨네요~! 수고하셨습니당

[rkdehdrbs7885-oss]

수고하셨습니다!