Message States 요청

이성은·2022년 12월 5일
0
post-custom-banner

코드스테이츠에서 운영 중인 Message States Server의 API 문서를 읽고 Postman으로 직접 실습

Endpoint
http://3.36.72.17:3000

  • root-endpoint(혹은 root-URL): API로 요청을 서버와 통신할 때, 서버가 요청을 수락하는 시작점을 뜻한다.

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인 호스트의 루트(/)이다.

  • path: path(또는 url-path)는 API를 통해 서버와 통신할 때, 서버와 통신할 수 있는 key 역할을 한다. 서버에 정의된 문자열에 따라 path가 달라진다. 예를 들어, https://api.github.com/user에서는 'user'가 path이다.

메세지 조회

Request

이 요청에는 추가적인 파라미터(query parameter)를 사용할 수 있다.

  • /dltjddmssl/messages?roomname=로비

Response

  • 응답은 JSON형식이다.
  • 메세지에서 사용하는 속성

메시지 추가

Request
요청 본문엔 다음 내용을 반드시 포함

  • 요청 형식: JSON
    • MIME 타입: application/json

Response
응답은 JSON 형식

메시지 초기화

Request
요청 본문은 필요하지 않다.

Response
응답은 JSON 형식

Open Weather Map에 날씨를 요청(GET)하고, 응답을 확인

Request

Response

{
    "coord": {
        "lon": 126.9778,
        "lat": 37.5683
    },
    "weather": [
        {
            "id": 800,
            "main": "Clear",
            "description": "clear sky",
            "icon": "01d"
        }
    ],
    "base": "stations",
    "main": {
        "temp": 274.34,
        "feels_like": 272.01,
        "temp_min": 272.84,
        "temp_max": 275.81,
        "pressure": 1028,
        "humidity": 27
    },
    "visibility": 10000,
    "wind": {
        "speed": 2.06,
        "deg": 310
    },
    "clouds": {
        "all": 0
    },
    "dt": 1670221097,
    "sys": {
        "type": 1,
        "id": 8105,
        "country": "KR",
        "sunrise": 1670193092,
        "sunset": 1670228029
    },
    "timezone": 32400,
    "id": 1835848,
    "name": "Seoul",
    "cod": 200
}
profile
함께 일하는 프론트엔드 개발자 이성은입니다🐥
post-custom-banner

0개의 댓글