Document Title

소켓 이벤트에 대한 추가적인 정보를 적습니다.

Namespace

Path만 씁니다. root경로를 포함한 절대 경로를 쓰지 않습니다.

Sender / Receiver:

송수신 주체에 관해서 적습니다.

Sender:

Client | Receiver

Receiver:

Client | Receiver

Event:

Event명을 적습니다.

Message(Payload)

Type:

json | text | binary

Required:

id: number

Optional:

photo_id: string

Playload format

메시지 playload가 어떤식으로 보여야 되는지 적습니다.

{
  "id" : "1",
  "photo_id": "cute_cat#112"
}

Success Response:

성공한 경우 반환되는 데이터는 무엇인지 다시 다른 이벤트로 emit을 하는지 적습니다.

Response: { id : 12 }

Error Response:

이 event는 여러가지 이유로 Fail하거나 Reject될 수 있습니다.

ex. 권한 없음, 잘못된 형식의 payload, 등

Failure에 관한 것은 모두 여기에 적습니다.

Error Type: UNAUTHORIZED

Content: { error : "Log in" }

OR

Error Type: UNPROCESSABLE ENTRY

Content: { error : "Invalid room id" }

Sample Call:

위 이벤트를 호출해서 보여주는 샘플 예제입니다.

동영상이 될 수도 있고 Socket.io코드가 될 수도 있고 포스트맨의 캡처본이 될 수도 있습니다.

Notes:

이 문서에 대해 모호한 점, 더 자세한 주석, API에 대한 논의 내용, 등을 정리하는 곳입니다.