[Tools] API postman

postman 이란

어떤 api시스템을 이용해 개발하고 싶을때 쉽게 요청, 응답받아서 정보를 미리보고 개발하기 위한 유틸이라고 보면 된다.

postman 사용이유

예를 들어, 날씨정보를 가져오는걸 구현 하고 싶다고 가정하자.

우리는 기상청에 해당 지역과 시간에 대한 날씨 데이터를 요청한다. 

기상청은 날씨 데이터 집합체(api)에서 우리의 요청을 받아 데이터를 보내준다.

그때 내가 보내야하는 기상청의 API방식에 의한 소스를 작성해서 보내야하는데 우리는 그 방식을 따르며 개발하는데 공수가 너무 든다는 것이다.

그래서 postman 이라는 편리한 앱을 통하여 정확한 주소와 토큰키 지역 등 필수 입력 값만 보내서 응답값을 먼저 확인 해 보는 것이다. 그러면 보내준 응답에서 필요한 날씨 정보만 가지고 우리는 ui화면을 개발 할 수 있을 것이다. 

요청을 보내는 방식에는

GET, POST, PUT, DELETE HEAD, PATCH, COPY 등등.. 이 있는데 GET, POST, PUT, DELETE 이 네가지가 대표 적인 방법이다.

CRUD Operation
Create : 생성(POST)
Read : 조회(GET)
Update : 수정(PUT)
Delete : 삭제(DELETE)
HEAD: header 정보 조회(HEAD) 

라고 볼 수 있다. 이거를 우리는 REST 원리 방식이라고 하는데 정확한지는 아직 필자도 모르겠다..

REST의 개념은 후에 작성한 글에서 다시 보도록한다.

REST API 와 GraphQL (tistory.com)

REST API 와 GraphQL

postman 사용법

먼저 postman 웹사이트에 계정을 만든다. 가입과정은 쉬우니 생략하겠다.

그러고 나면 postman 사이트에서 직접 실행할 수도 있고 다운로드도 가능하다. 구글 계정으로 들어 간 후

new http request 인가 그걸 선택하면 요청보내고 응답 받는 화면이 나올것이다.

그럼 간단한 예제로 postman 을 통해 날씨 api 를 요청하는 실습을 한번 해보자.

내가 사용한 날씨 api  주소는 https://openweathermap.org/current 여기였다.

이 사이트를  참조하여 get방식으로 postman에서 보내보았다.

검은색부분은 나의 날씨api 고유키값이다.

 https://openweathermap.org/current 사이트에서 필요한 값을 던져줄 것을 참조하여 넣어보고 응답을 확인해본다.

 

 id=524901 lang=kr &appid="~~~"

이렇게 키에 해당하는 값을 작성하니 josn 방식으로 밑에 한국어로 값이 넘어오는 것을 확인할 수 있다.

내가 lang을 kr로 입력했기 때문.

id 는 도시 ID인데 도시 ID 'city.list.json.gz' 목록다운로드는 위에 사이트에서 받아서 골라 입력한다.

필자는 먼저 예제에 id=524901 있는 것을 가져왔었다.

 

이번엔 매개변수 q 를 이용하여 도시를 넣어 현재 날씨를 요청해보았다.

런던의 현재 날씨 요청

jons 형태말고도 xml , html, text 등으로 응답을 받을 수 있다. 

이렇게 postman을 통해 미리 응답을 보면서 내가 필요한 값들만 가져다가 api 기능을 만든다고 보면 되겠다.

 

 

참고 : 필자도 아직 신입으로 공부중이라 아직 부족한 점들이 많다는 점. 내용이나 개념이 아직 확실치 않다는 점을 유의하며 읽어주세요.

만일, 잘못된 정보나 지식이 있다면 알려주시길 바랍니다.