Message States Server

Endpoint

• root-endpoint( root-URL )

: API 로 요청을 서버와 통신할 때, 서버가 요청을 수락하는 시작점을 의미합니다.

 

• path ( url-path )

: path 는 API 를 통해 서버와 통신할 때, 서버와 통신할 수 있는 key 역할을 합니다.

서버에 정의된 문자열에 따라 path 가 달라집니다. 예를 들어, https://api.github.com/user 에서는

'user' 가 path입니다.

 

Github API 의 root-endpoint
: https://api.github.com

트위터 API 의 root-endpoint
: https://api.twitter.com

일반적으로 root-endpoint 는 도메인 주소와 루트(/) 를 가리킵니다.

마찬가지로 Message States Server 의 URL 을 기준으로 파악할 수 있는 root-endpoint 는
Message States Server 의 가장 마지막 Location 인 호스트의 루트(/) 입니다.

 

 

메시지 조회

Request

GET /{githubID}/messages

* 추가적인 피라미터 : /{GithubID}/message?roomname=로비

 

Response

 

( 예시 )

[
  {
     "username": "김코딩", "text": "안녕하세요", "roomname": "로비",
   },
   // ...여러 개의 메시지
]

 

 

메세지 추가

Request

POST /{githubID}/messages

 

Response

 

(예시)

{
   "id": 5
}

 

 

메세지 초기화

Request

POST /{githubID}/clear

 

Reponse

 

(예시)

{
   "message": "message initialized!"
}