Postman

Taehye.on·2023년 3월 30일
0

코드스테이츠 44기

목록 보기
45/89
post-thumbnail

D-32

🔍 Postman

Postman은 HTTP 요청을 테스트할 수 있는 다양한 API 테스트 도구 중 하나다.
이러한 API 테스트 도구는 클라이언트 입장에서 서버 API를 테스트하거나, API를 만드는 과정에 유용하다.

📌 POST 요청

POST 요청은 GET 요청과 다르게 본문(body)을 포함하는 경우가 많다.

  • URL : http://3.36.72.17:3000/
  • 메세지 추가
  •  Request
    
    POST /kimcoding/messages
      [요청] kimcoding이 새로운 message를 작성한다.
  • 본문 (파라미터 정보)

  • parameter형식설명필수 포함 여부
    username문자열사용자 이름필수
    text문자열본문 내용필수
    roomname문자열방 이름필수

      요청 형식: JSON
  • 응답은 다음과 같은 JSON 형식이다.
  •  Request에 따른 Response 예시
    
    {
      "id": 5
    }
      id는 숫자 형식이며, 새로 생성된 메시지의 고유한 ID 값이다.

    🔍 API Key발급

    Open Weather Map사이트에서 API Key를 발급했다.

    api.openweathermap.org/data/2.5/weather?id={city id}&appid={your api key}

    By city ID에서 제공받은 URI다.
    데이터를 정상적으로 받아올 수 있는지, URI는 정상 작동하는지 확인하기 위해 브라우저 검색창에 입력해 확인한다.

    크롬 확장 프로그램 JSON Viewer를 설치해 JSON 데이터 타입 형식으로 데이터를 확인할 수 있다.


    📌 GET으로 날씨 요청

    {city id} = 서울, 1835848
    {your api key} = 발급받은 API Key

    GET 요청으로 응답을 확인할 수 있다.


    🔍 Message States

    코드스테이츠에서 운영 중인 Message States Server의 API 문서를 읽고 Postman으로 확인해보자.

    📌 Endpoint

    http://3.36.72.17:3000

  • root-endpoint(root-URL)
    • API로 요청을 서버와 통신할 때, 서버가 요청을 수락하는 시작점을 뜻한다. root-endpoint는 도메인 주소의 루트(/)를 가리킨다.
  • path(url-path)
    • path는 API를 통해 서버와 통신할 때 서버와 통신할 수 있는 key 역할을 한다. 서버에 정의된 문자열에 따라 path가 달라진다.

    ex> https://api.github.com/user 에서는 'user'가 path다.

    📌 githubID가 작성한 메세지 추가

    📌 githubID가 작성한 메세지 초기화

    POST 요청이 성공하면, 서버에 전부 저장된다.

    0개의 댓글