Chore: 세션 관련 swagger 문서 추가

Author: sso0om

back/src/main/java/com/back/domain/mentoring/session/controller/MentoringSessionController.java

@@ -5,45 +5,47 @@
 import com.back.domain.mentoring.session.service.MentoringSessionManager;
 import com.back.global.rq.Rq;
 import com.back.global.rsData.RsData;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import lombok.RequiredArgsConstructor;
 import org.springframework.security.access.prepost.PreAuthorize;
-import org.springframework.security.core.annotation.AuthenticationPrincipal;
 import org.springframework.web.bind.annotation.*;
 
 @RestController
 @RequiredArgsConstructor
 @RequestMapping("/sessions")
+@Tag(name = "MentoringSessionController", description = "멘토링 세션 API - 화상 채팅으로 멘토링 진행")
 public class MentoringSessionController {
     private final MentoringSessionManager mentoringSessionManager;
     private final Rq rq;
 
-    //세션참여 URL발급
     @GetMapping("/{sessionId}/url")
+    @Operation(summary = "세션참여 URL 발급", description = "세션 참여를 위한 URL을 발급합니다.")
     public RsData<GetSessionUrlResponse> getSessionUrl(@PathVariable Long sessionId) {
         GetSessionUrlResponse response = mentoringSessionManager.getSessionUrl(sessionId);
         return new RsData<>("200", "요청완료", response);
     }
 
-    //세션 상세 정보(참여 현황?, 제목 등등?)
     @GetMapping("/{sessionId}")
+    @Operation(summary = "세션 상세 정보", description = "세션 제목, 멘토, 멘티, 메시지 목록 등 세션의 상세 정보를 조회합니다.")
     public RsData<GetSessionInfoResponse> getSessionDetail(@PathVariable Long sessionId) {
         GetSessionInfoResponse response = mentoringSessionManager.getSessionDetail(sessionId);
         return new RsData<>("200", "요청완료", response);
     }
 
-    //세션 열기
     @PutMapping("/{sessionId}")
     @PreAuthorize("hasRole('MENTOR')")
+    @Operation(summary = "세션 열기", description = "세션을 열어 멘토링을 진행합니다.")
     public RsData<OpenSessionResponse> openSession(@PathVariable Long sessionId) {
         Member member = rq.getActor();
         OpenSessionRequest openSessionRequest = new OpenSessionRequest(sessionId);
         OpenSessionResponse response = mentoringSessionManager.openSession(member, openSessionRequest);
         return new RsData<>("200", "세션 오픈 완료", response);
     }
 
-    //세션종료
     @DeleteMapping("/{sessionId}")
     @PreAuthorize("hasRole('MENTOR')")
+    @Operation(summary = "세션 종료", description = "세션을 닫아 멘토링을 종료합니다.")
     public RsData<CloseSessionResponse> closeSession(@PathVariable Long sessionId) {
         Member member = rq.getActor();
         DeleteSessionRequest deleteSessionRequest = new DeleteSessionRequest(sessionId);

back/src/main/java/com/back/domain/mentoring/session/dto/ChatMessageRequest.java

@@ -1,10 +1,12 @@
 package com.back.domain.mentoring.session.dto;
 
 import com.back.domain.mentoring.session.entity.MessageType;
-import com.back.domain.mentoring.session.entity.SenderRole;
+import io.swagger.v3.oas.annotations.media.Schema;
 
 public record ChatMessageRequest(
+        @Schema(description = "메시지 타입", example = "TEXT")
         MessageType type,
+        @Schema(description = "메시지 내용", example = "msg")
         String content
 ) {
 }

back/src/main/java/com/back/domain/mentoring/session/dto/ChatMessageResponse.java

@@ -1,10 +1,15 @@
 package com.back.domain.mentoring.session.dto;
 
+import io.swagger.v3.oas.annotations.media.Schema;
+
 import java.time.LocalDateTime;
 
 public record ChatMessageResponse(
+        @Schema(description = "작성자명")
         String senderName,
+        @Schema(description = "메시지 내용")
         String content,
+        @Schema(description = "작성일시")
         LocalDateTime createdAt
 ) {
 }

back/src/main/java/com/back/domain/mentoring/session/dto/CloseSessionResponse.java

@@ -1,8 +1,13 @@
 package com.back.domain.mentoring.session.dto;
 
+import io.swagger.v3.oas.annotations.media.Schema;
+
 public record CloseSessionResponse(
+        @Schema(description = "세션 URL")
         String sessionUrl,
+        @Schema(description = "멘토링 제목")
         String mentoringTitle,
+        @Schema(description = "세션 상태")
         String status
 ) {
 }

back/src/main/java/com/back/domain/mentoring/session/dto/DeleteSessionRequest.java

@@ -1,6 +1,9 @@
 package com.back.domain.mentoring.session.dto;
 
+import io.swagger.v3.oas.annotations.media.Schema;
+
 public record DeleteSessionRequest(
+        @Schema(description = "세션 ID")
         Long sessionId
 ) {
 }

back/src/main/java/com/back/domain/mentoring/session/dto/GetSessionInfoResponse.java

@@ -1,9 +1,15 @@
 package com.back.domain.mentoring.session.dto;
 
+import io.swagger.v3.oas.annotations.media.Schema;
+
 public record GetSessionInfoResponse(
+        @Schema(description = "멘토링 제목")
         String mentoringTitle,
+        @Schema(description = "멘토 이름")
         String mentorName,
+        @Schema(description = "멘티 이름")
         String menteeName,
+        @Schema(description = "세션 상태")
         String sessionStatus
 ) {
 }

back/src/main/java/com/back/domain/mentoring/session/dto/GetSessionUrlResponse.java

@@ -1,6 +1,9 @@
 package com.back.domain.mentoring.session.dto;
 
+import io.swagger.v3.oas.annotations.media.Schema;
+
 public record GetSessionUrlResponse(
+        @Schema(description = "세션 URL")
         String sessionUrl
 ) {
 }

back/src/main/java/com/back/domain/mentoring/session/dto/OpenSessionRequest.java

@@ -1,6 +1,9 @@
 package com.back.domain.mentoring.session.dto;
 
+import io.swagger.v3.oas.annotations.media.Schema;
+
 public record OpenSessionRequest(
+        @Schema(description = "세션 ID")
         Long sessionId
 ) {
 }

back/src/main/java/com/back/domain/mentoring/session/dto/OpenSessionResponse.java

@@ -1,8 +1,13 @@
 package com.back.domain.mentoring.session.dto;
 
+import io.swagger.v3.oas.annotations.media.Schema;
+
 public record OpenSessionResponse(
+        @Schema(description = "세션 URL")
         String sessionUrl,
+        @Schema(description = "멘토링 제목")
         String mentoringTitle,
+        @Schema(description = "세션 상태")
         String status
 ) {
 }