Skip to content

Commit 5b25afe

Browse files
committed
Docs: Swagger 어노테이션 추가
1 parent fe71978 commit 5b25afe

File tree

3 files changed

+11
-0
lines changed

3 files changed

+11
-0
lines changed

src/main/java/com/back/domain/chat/controller/ChatApiController.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
import com.back.domain.chat.service.ChatService;
55
import com.back.global.common.dto.RsData;
66
import com.back.global.security.CustomUserDetails;
7+
import io.swagger.v3.oas.annotations.Operation;
8+
import io.swagger.v3.oas.annotations.tags.Tag;
79
import lombok.RequiredArgsConstructor;
810
import org.springframework.format.annotation.DateTimeFormat;
911
import org.springframework.http.HttpStatus;
@@ -16,12 +18,14 @@
1618
@RestController
1719
@RequiredArgsConstructor
1820
@RequestMapping("/api")
21+
@Tag(name = "Chat API", description = "채팅 메시지 조회 관련 API")
1922
public class ChatApiController {
2023

2124
private final ChatService chatService;
2225

2326
// 방 채팅 메시지 조회 (페이징, 특정 시간 이전 메시지)
2427
@GetMapping("/rooms/{roomId}/messages")
28+
@Operation(summary = "채팅방 메시지 목록 조회", description = "특정 채팅방의 이전 메시지 기록을 페이징하여 조회합니다.")
2529
public ResponseEntity<RsData<ChatPageResponse>> getRoomChatMessages(
2630
@PathVariable Long roomId,
2731
@RequestParam(defaultValue = "0") int page,

src/main/java/com/back/domain/chat/controller/ChatWebSocketController.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
import com.back.global.security.CustomUserDetails;
66
import com.back.global.websocket.dto.WebSocketErrorResponse;
77
import com.back.domain.chat.service.ChatService;
8+
import io.swagger.v3.oas.annotations.tags.Tag;
89
import lombok.RequiredArgsConstructor;
910
import org.springframework.messaging.handler.annotation.DestinationVariable;
1011
import org.springframework.messaging.handler.annotation.MessageMapping;
@@ -17,6 +18,7 @@
1718

1819
@Controller
1920
@RequiredArgsConstructor
21+
@Tag(name = "Chat WebSocket", description = "STOMP를 이용한 실시간 채팅 WebSocket 컨트롤러 (Swagger에서 직접 테스트 불가)")
2022
public class ChatWebSocketController {
2123

2224
private final ChatService chatService;

src/main/java/com/back/global/websocket/controller/WebSocketTestController.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
package com.back.global.websocket.controller;
22

33
import com.back.global.common.dto.RsData;
4+
import io.swagger.v3.oas.annotations.Operation;
5+
import io.swagger.v3.oas.annotations.tags.Tag;
46
import lombok.extern.slf4j.Slf4j;
57
import org.springframework.http.HttpStatus;
68
import org.springframework.http.ResponseEntity;
@@ -15,10 +17,12 @@
1517
@Slf4j
1618
@RestController
1719
@RequestMapping("/api/websocket")
20+
@Tag(name = "WebSocket Test API", description = "WebSocket 서버 상태 확인 및 연결 정보 제공 API")
1821
public class WebSocketTestController { // WebSocket 기능 테스트용 REST 컨트롤러
1922

2023
// WebSocket 서버 상태 확인
2124
@GetMapping("/health")
25+
@Operation(summary = "WebSocket 서버 헬스체크", description = "WebSocket 서비스의 현재 상태를 확인합니다.")
2226
public ResponseEntity<RsData<Map<String, Object>>> healthCheck() {
2327
log.info("WebSocket 헬스체크 요청");
2428

@@ -40,6 +44,7 @@ public ResponseEntity<RsData<Map<String, Object>>> healthCheck() {
4044

4145
// WebSocket 연결 정보 제공
4246
@GetMapping("/info")
47+
@Operation(summary = "WebSocket 연결 정보 조회", description = "클라이언트가 WebSocket에 연결하기 위해 필요한 정보를 제공합니다.")
4348
public ResponseEntity<RsData<Map<String, Object>>> getConnectionInfo() {
4449
log.info("WebSocket 연결 정보 요청");
4550

0 commit comments

Comments
 (0)