요청 응답 규칙

• WS 연결 시점: 로그인
  • 회원 상태(온라인/오프라인/게임)
  • 알림(새로운 답장, 게임 초대가 왔습니다 등)
• 클라이언트→서버 요청은 REST API로 한다
• 서버→클라이언트 푸시는 WS로 한다

[ Chat socket ]

Connect params

• 채팅 서버에 접속하기 위한 정보를 query로 보냅니다.
• 예) ws://localhost:8000/chat
• errors
  • UnauthorizedRequest

Channel

the-pong_api_channel

메시지 받기

• event: message

• data:

  {
  	"id": number,
  	"channelId": number,
  	"senderId": number,
  	"senderNickname": string,
  	"text": string,
  	"createdAt": string
  }
  

채널 로그

채널 설정, 참가자 등의 정보가 변경되었을 때. 클라이언트가 notice를 받으면, REST API로 채널 정보를 새로 요청한다.

• event: notice

• data

  {
  	"id": number,
  	"channelId": number,
  	"text"?: string,
  	"code": number, // 상황별 code는 아래 참조
  	"users": [ // 상황에 해당하는 회원 목록
  		{
  			"id": number,
  			"nickname": string
  		},
  		// ...
    ]
  	"createdAt": string
  }
  

  • code

접속 중인 채널 참가자 정보 변경

• 유저가 자신의 정보를 수정하면, 참가 중인 채널에 소켓 메세지를 보낸다.
• event: user