Swagger UI Notification 문서 링크 : https://api.ezcode.my/swagger-ui/index.html

기능 개요

• 웹소켓을 구독하여 실시간으로 알림을 받을 수 있습니다.
• 알림 목록 조회(GET) 등의 요청을 보내면 웹소켓으로 해당 데이터를 수신합니다.
• 알림 기능 같은 경우 세션키를 받아서 세팅한다던지 등의 전처리나 별도의 설정이 필요 없습니다!

신규 알림 구독 경로 : /user/queue/notification

• 신규 알림 수신 시 UI에 반영

  • isRead 필드가 있어 이를 기준으로 판별

  

알림 목록 구독 경로 : /user/queue/notifications

• 알림 버튼 눌렀을 때 알림 목록 조회

  

• 알림 전체 보기 등의 페이지에서 사용 (”알림 더보기” 버튼 클릭 시 페이지 이동)

  

  • 해당 화면에서 “더 보기” 버튼을 누르면 다음 page의 알림 목록 요청

• 알림 목록은 페이지 단위로 조회함 (page, size) → 해당 알림 데이터들은 읽음 처리

기타

• 서버 측에 알림 목록 조회 시에는 REST API의 GET 요청을 날리면, 웹소켓 구독 경로 /user/queue/notifications에서 전달받을 수 있습니다.

• REST API로 요청하고, 웹소켓으로 데이터를 수신하는 형태입니다. 책임 분리, API 로깅 및 모니터링 등을 위해 이런 구조를 선택했습니다.

• redirect url은 프론트 측과 상의 후 결정하려고 합니다.

• 현재는 포괄적인 메시지만 전달하고 있습니다. ex) “댓글에 추천을 받았습니다.” 등

  • 이 부분은 payload 데이터를 활용해서 좀 더 자세하게 메시지를 보여줄 수 있을 것 같습니다.
    • ex) ~님이 작성하신 댓글에 추천을 했습니다
    • ex) ~님이 작성하신 토론글에 댓글을 달았습니다. “토론글 댓글 내용 어쩌구~”

알림 조회 및 읽음 처리 API 부가 설명

GET /api/notifications - 알림 목록 조회