유용한 툴

[유용한 툴] API 테스트를 위한 유용한 툴 :: Postman 설치 및 사용방법 (+꿀팁)

쌍쌍바나나 2016. 5. 28. 10:06
반응형

API 테스트를 위하여 포스트맨(Postman)을 설치 및 사용하는 방법 (+꿀팁)

들어가며

  우리가 서버를 구축하고 나서 요청/응답을 주고받는 API 서버를 만들게 되는 경우에 대해서 설명하려고 합니다. 요청/응답 테스트를 하기 위해서는 실제 개발하고 있는 클라이언트(안드로이드, 웹, 등)에서 실제 요청을 보내고, 그 요청에 대한 응답을 받는 테스트가 가능합니다. 이제서야 말하는데 여기서 말하는 요청은 HTTP Request, 응답은 HTTP Response입니다. 그렇다면 실제로 개발할때 클라이언트에서 버튼을 만들고, 이벤트를 만들고, 버튼에 이벤트를 등록하고, 버튼을 누르면 해당 이벤트를 실행하고, 이벤트에서는 요청을하고, 요청을 한 후에 응답을 받고, 그 응답을 받은 내용을 화면에 출력하고, 등의 작업이 너무 길어지게 됩니다. 물론 간단한 요청은 URL을 통해 가능하지만, 그 외에 데이터를 주고 받거나 하는 경우에는 URL을 통해서 테스트를 하는것도 한계가 있습니다. 또한 Authorization이나 Header, Body를 수정하는건 더욱더 제한이 있습니다. 하지만 포스트맨은 요청만 보내고, 응답을 받으면 끝입니다. 해당 작업을 할 수 있도록 인터페이스를 구축해놓은 툴이기 때문에 누구나 쉽게 사용이 가능합니다. 설치를 시작으로 사용방법, 그리고 꿀팁까지 전수해드리겠습니다.  

설치하기  

  위의 번거로움을 해소해주는 유용한 개발 툴이 있어서 소개해드릴려고 합니다. 그 이름은 바로 Postman하늘로 솟아 오르고 있습나다. 해당 앱은 크롬의 Webstore에서 다운로드가 가능합니다. [다운로드 받기]

장점  

  postman의 가장 큰 장점은 OS에 상관없이 어디에서나 사용이 가능하고, 가벼운 툴이여서 빠르게 사용이 가능합니다. 또한 계정을 보유하고 있다면, 내가 요처한 히스토리, 테스트한 환경을 그대로 보유하고 있기 때문에 언제 어디서나 바로 내가 테스트 했던 환경이 구축된다는 점~~ 아주 훌륭하지요.

사용방법

  아래 포스트맨을 시작하면 계정을 생성할지 아니면 "Skip this, go straight to the app"인지 선택을 하게 됩니다. 아무래도 자주 다른 환경에서 테스트를 하기 위함이다! 라면 계정을 만드는게 좋겠죠? 급한분은 계정없이 바로고! 도 가능하다는점입니다. 

  이제 실제 작업을 할 수 있는 공간의 화면인데요. 포스트 맨에서는 거의 모든 요청을 제공하네요. 저도 여기서는 GET, POST, PUT, DELETE 뿐이 사용을 안해봤습니다.

  간단한 사용 예제를 보여드릴께요. 위에 보시면 요청의 타입을 선택이 가능한데, 저는 GET요청을 해보겠습니다. 시나리오는 구글에 postman이라고 검색했을 때 응답이 무엇일까... 하지만 구글은 검색 결과를 우리가 실제 보여주는 화면을 리턴해주지 않네요. (보안때문인건지...) 다른 사이트는 화면에 있는 그대로 있는 화면을 가져와 해당 이미지의 url뿐만 아니라 링크의 정보도 가져올 수 있습니다. 아래 내용을 보면 query로 postman을 넘겼습니다. 자동으로 ?뒤에 query=postman이 url로 append된 것을 볼 수 있습니다. 

  다음 예제는 GET이 아닌 우리가 데이터를 서버로 전송하려고 할때 Body에 데이터를 넣어서 요청하는 POST방식입니다. <key, value> 형태로 데이터를 추가하시면 됩니다. 이미지 파일과 파일의 filename을 포함한 요청을 하게 되면 서버에서는 POST요청에서 이미지와 이미지의 filename을 받아올 수 있습니다. 물론 서버에 해당 메소드를 구현을 해야겠지요.

  여기서 하나의 팁, 여기까지 오셨다면 이정도는 얻어가야 합니다. 일단 오른쪽에 있는 Generate Code가 보입니다. 이것이 바로 마법코드 생성기라고 할 수 있습니다. 요청은 항상 동일한데 언어별로 코딩해야 하는 내용이 다릅니다. 예를들어 POST의 요청으로 데이터를 전송하는 위의 예제를 코드로 구현해보겠습니다. ??? 어느코드로? Java? Python? 이때 바로 왼쪽에 있는 Java OK HTTP를 이용하여 위의 코드를 구현한 애용을 바로 코드로 생성할 수 있습니다. 오마이갓 사용하기 위해서는 코드를 복사해서 그대로 사용하시면 됩니다. 추가적으로 라이브러리를 설치하는 것도 있습니다만 그정도의 노력쯤이야. 

서버와 클라이언트에서 요청/응답을 주고 받을때 postman을 써서 좀 더 효율적으로 테스트를 진행해 보세요.




반응형