[WEB] Postman - Weather API 사용해보기

Postman이란?

서버에 HTTP 요청을 보내고 결과를 받아올 수 있는 플랫폼이다. 주로 API 를 테스트 할 때 사용한다.

GET 요청 같은 경우 URI를 활용해 브라우저에서도 충분히 테스트 할 수 있지만, GET 요청이 아닌 다른 요청을 보낼때는 조금 번거로워진다. 이 때 Postman 같은 도구를 사용하면 쉽게 API를 테스트할 수 있다. 

Postman 시작하기

• 좌측 상단 Workspaces 탭에서 새로운 워크스페이스를 생성하거나, 기존 워크스페이스에서 작업할 수 있다. 워크스페이스 생성 후 콜렉션을 생성해 API 호출 기록을 저장해 둘 수 있다.

• New 탭에서 HTTP Request 를 선택하면 새로운 요청을 생성할 수 있다.

GET 요청

• Open Weather Map API 를 활용하여 현재 날씨를 받아오는 GET 요청을 해보자! 링크된 API DOC에서 스크롤을 내려보면 여러가지 형태로 API를 호출하도록 안내하고 있다. 

city name 으로 API 요청하기

city id로 API 요청하기

• 원하는 API 호출을 복사해서 Postman에 붙여넣기 해준다. 

• request URI 붙여넣기만 해도, 해당 URI를 파악해 쿼리 파라미터를 key 와 value로 구분하여 편하게 볼 수 있다. 

Query Prams의 KEY 와 VALUE

•  파라미터는 URL 경로에 추가적인 정보(질문, 질의)를 전달해 리소스를 식별할 수 있도록 도와준다. 여기서 쿼리 파라미터는 URL 뒤에 ? 로 연결되며, 여러개의 쿼리 파라미터는 & 기호로 연결한다. 주로 키워드를 검색하거나 조건에 따라 필터링을 할 때 사용한다. 
• 쿼리는 키와 값 쌍의 형식으로 표현할 수 있다. ? 뒷편의 id = 123 이라는 쿼리가 있을 때 key는 id이고 value는 123을 의미한다. id 라는 키의 값이 123인 리소스를 검색하여 조회하는 것이다. 

/users?id=123

다시 Postman Wheather API 로 돌아가서 살펴보면, KEY 에 q 와 appid 라는 항목이 있고, 각 value에 {city name} 과 {API key} 를 입력하도록 되어있다. 여기에 적절한 값을 입력하면 자동으로 URI를 생성해주고, SEND 버튼을 클릭해 요청을 해주면 원하는 데이터를 조회할 수 있다. (API Key는 발급받은 뒤 이 링크 에서 확인할 수 있다.)

위 이미지와 같이 Seoul의 날씨 데이터를 JSON으로 조회할 수 있다. 

+ POST 요청

• Postman으로 HTTP POST 요청을 할 때는, Body 탭에 전달 데이터를 입력하여 요청을 할 수 있다.

상단 탭에서 다양한 전송 형식을 선택할 수 있다. raw 탭을 클릭하면 전송 데이터의 형식과 내용을 직접 작성하여 전달할 수 있다. 

 

참고자료

https://ryan-han.com/post/translated/pathvariable_queryparam/

[번역] Path Variable과 Query Parameter는 언제 사용해야 할까? | Integerous DevLog

https://react.vlpt.us/react-router/02-params-and-query.html

2. 파라미터와 쿼리 · GitBook

https://binit.tistory.com/17

포스트맨(Postman) 사용법과 API 실행해 보기