Skip to content

[Documnet] 스웨거 정리 및 스웨거 페이지별 그룹 처리(#78)#175

Merged
jaehyeok-code merged 3 commits intomainfrom
dev
Aug 26, 2025
Merged

[Documnet] 스웨거 정리 및 스웨거 페이지별 그룹 처리(#78)#175
jaehyeok-code merged 3 commits intomainfrom
dev

Conversation

@jaehyeok-code
Copy link
Contributor

@jaehyeok-code jaehyeok-code commented Aug 26, 2025

Summary by CodeRabbit

  • New Features

    • Redis 기반 채팅 메시지/알림 브로드캐스트를 활성화하여 채팅방 전달 경로를 확장했습니다.
    • OpenAPI 문서를 도메인별 그룹(채팅, 채팅검색, 유저, 드래프트, 선수, 선수캐시, 선수검색, 매치, 팀, 라운드)으로 분리했습니다.
  • Documentation

    • 다수의 API에 태그, 요약, 응답 코드, 파라미터 설명을 추가했습니다: 채팅 히스토리/읽음/방 조회·관리, 알림, 채팅 검색/재인덱싱, 드래프트, 선수 캐시·검색.
    • Swagger UI에서 가독성과 탐색성이 개선되었습니다.

@jaehyeok-code jaehyeok-code self-assigned this Aug 26, 2025
@jaehyeok-code jaehyeok-code added the documentation Improvements or additions to documentation label Aug 26, 2025
@jaehyeok-code jaehyeok-code merged commit 83a76da into main Aug 26, 2025
1 check passed
@coderabbitai
Copy link

coderabbitai bot commented Aug 26, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

Redis 기반 채팅 Pub/Sub 구성(@Component/@configuration)과 컨트롤러/서비스의 메시지 전송 경로를 Redis 발행으로 전환했다. 동시에 다수의 컨트롤러에 OpenAPI/Swagger 문서 주석을 추가했고, OpenAPI 그룹 구성 Bean들을 도입했다. 기능 로직 변경은 주로 메시징 경로 전환에 국한된다.

Changes

Cohort / File(s) Summary
Redis Pub/Sub 활성화 및 전송 경로 전환
backendProject/.../chat/bus/ChatRedisPublisher.java, backendProject/.../chat/bus/ChatRedisSubscriber.java, backendProject/.../chat/bus/RedisPubSubConfig.java, backendProject/.../chat/controller/ChatMessagingController.java, backendProject/.../chat/controller/ChatNotificationController.java, backendProject/.../chat/service/Impl/ChatNotificationServiceImpl.java
Publisher/Subscriber/@configuration 주석 해제로 빈 등록 활성화. ChatMessagingController/ChatNotificationController/NotificationService가 WebSocket 직접 전송에서 Redis publish(채널 fan-out)로 경로 전환 또는 병행 호출.
Chat 도메인 API 문서화
backendProject/.../chat/controller/ChatHistoryController.java, .../ChatReadController.java, .../ChatRoomQueryController.java, .../elasticsearch/ChatReindexController.java, .../elasticsearch/controller/ChatSearchController.java
@tag, @operation, @ApiResponses, @parameter 추가로 엔드포인트 문서화. 실행 로직 변경 없음.
Draft API 문서화 및 파라미터 주석/정정
backendProject/.../draft/controller/DraftController.java
OpenAPI 주석 추가. isWithinSquadLimits의 elementTypeId 파라미터 키 오타 수정(participantIdelementTypeId).
Player API 문서화
backendProject/.../player/cache/controller/PlayerCacheController.java, .../player/elasticsearch/controller/PlayerEsController.java
캐시/검색 엔드포인트에 OpenAPI 주석 추가. 로직 변경 없음.
OpenAPI 그룹 구성 추가
backendProject/.../global/configuration/OpenApiConfig.java
여러 GroupedOpenApi Bean 추가(chat, chatSearch, user, draft, player, playerCache, playerEs, match, team, round). 기존 openAPI() 유지.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant C as Client
  participant CMC as ChatMessagingController
  participant CRP as ChatRedisPublisher
  participant R as Redis (Pub/Sub)
  participant CRS as ChatRedisSubscriber
  participant SMT as SimpMessagingTemplate
  participant WS as WebSocket Clients

  C->>CMC: /app/chat/rooms/{roomId}/send (payload)
  CMC->>CRP: publishToRoom(roomId, payload)
  CRP-->>R: PUBLISH chat:room:{roomId} payload
  Note over R: 채널 fan-out
  R-->>CRS: onMessage(channel, body)
  CRS->>SMT: convertAndSend(/topic/chat/rooms/{roomId}, payload)
  SMT-->>WS: STOMP MESSAGE
Loading
sequenceDiagram
  autonumber
  participant API as ChatNotificationController
  participant CRP as ChatRedisPublisher
  participant R as Redis (Pub/Sub)
  participant CRS as ChatRedisSubscriber
  participant SMT as SimpMessagingTemplate
  participant WS as WebSocket Clients

  API->>SMT: convertAndSend(/topic/chat/rooms/{roomId}, payload)
  API->>CRP: publishToRoom(roomId, payload)
  CRP-->>R: PUBLISH chat:room:{roomId} payload
  R-->>CRS: onMessage(...)
  CRS->>SMT: convertAndSend(/topic/chat/rooms/{roomId}, payload)
  SMT-->>WS: STOMP MESSAGE
  Note over API,WS: WebSocket 브로드캐스트 + Redis fan-out 병행
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

Suggested reviewers

  • hwichoi0317
  • Kim-Jaehyun0328
  • wjkim9
  • roode1017

Poem

봄봄, 버니는 큐를 탔지 — 휙!
토픽 대신 레디스에 딱!
꽥꽥 소식은 퍼지고(=^.^=)
스웨거 문서도 반짝반짝✍️
딱딱! 채널 열리니
채팅별이 반짝인다 — 퐁!

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.


📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 5e57645 and 801f4b4.

📒 Files selected for processing (15)
  • backendProject/src/main/java/likelion/mlb/backendProject/domain/chat/bus/ChatRedisPublisher.java (1 hunks)
  • backendProject/src/main/java/likelion/mlb/backendProject/domain/chat/bus/ChatRedisSubscriber.java (1 hunks)
  • backendProject/src/main/java/likelion/mlb/backendProject/domain/chat/bus/RedisPubSubConfig.java (1 hunks)
  • backendProject/src/main/java/likelion/mlb/backendProject/domain/chat/controller/ChatHistoryController.java (1 hunks)
  • backendProject/src/main/java/likelion/mlb/backendProject/domain/chat/controller/ChatMessagingController.java (3 hunks)
  • backendProject/src/main/java/likelion/mlb/backendProject/domain/chat/controller/ChatNotificationController.java (3 hunks)
  • backendProject/src/main/java/likelion/mlb/backendProject/domain/chat/controller/ChatReadController.java (3 hunks)
  • backendProject/src/main/java/likelion/mlb/backendProject/domain/chat/controller/ChatRoomQueryController.java (2 hunks)
  • backendProject/src/main/java/likelion/mlb/backendProject/domain/chat/elasticsearch/ChatReindexController.java (1 hunks)
  • backendProject/src/main/java/likelion/mlb/backendProject/domain/chat/elasticsearch/controller/ChatSearchController.java (2 hunks)
  • backendProject/src/main/java/likelion/mlb/backendProject/domain/chat/service/Impl/ChatNotificationServiceImpl.java (3 hunks)
  • backendProject/src/main/java/likelion/mlb/backendProject/domain/draft/controller/DraftController.java (2 hunks)
  • backendProject/src/main/java/likelion/mlb/backendProject/domain/player/cache/controller/PlayerCacheController.java (1 hunks)
  • backendProject/src/main/java/likelion/mlb/backendProject/domain/player/elasticsearch/controller/PlayerEsController.java (1 hunks)
  • backendProject/src/main/java/likelion/mlb/backendProject/global/configuration/OpenApiConfig.java (2 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch dev

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant