Postman 개요 / 설치 / 사용법 / 활용 방법

Postman 개요 / 설치 / 사용법 / 활용 방법

Postman 이란 (https://www.getpostman.com/)

  Postman에 대한 설명은 아래와 같이 적혀 있습니다.

  (A powerful GUI platform to make your API development faster & easier, from building API requests through testing, documentation and sharing.)

  > API 개발을 빠르고 쉽게, 개발된 API를 테스트할 수 있고, 팀원들간 공유를 할 수 있게 해주는 플랫폼입니다.

  Postman을 간단한 tool이 아닌 플랫폼으로 소개하는 이유는 직접 사용해본다면 느껴지는데, 테스트뿐만 아니라 작년에 업데이트된 버전부터는 Team Library 탭을 통해서 팀원간의 Collection Sync, API Monitoring 등 협업에 도움을 주는 기능이 추가되었습니다. (Team Library 기능은 30일 trial version 후 유료로 사용해야 합니다. https://www.getpostman.com/pricing)

Postman 설치

  공식 홈페이지에서 다운받아 설치하며, 이메일 계정으로 가입 또는 구글 연동을 기본적으로 제공합니다. (Sync 기능을 위해 연동을 하는 것을 추천드립니다.)

초기에 설치된 모습입니다.

Postman 사용법

  가장 많이 사용하는 query string이 포함된 GET 방식의 호출과 JSON이 사용된 POST 방식의 호출을 샘플로 설명하겠습니다.

  

  1) Query string이 포함된 GET 방식의 호출

  URI에 query string이 포함된 경우 아래 key / value에 자동으로 추가가 되고, 호출 결과값은 아래 출력됩니다. JSON 포맷의 경우 자동으로 Formatting 됩니다.

  2) JSON이 사용된 POST 방식의 호출

  JSON이 포함된 POST 방식 호출 시 Body에 JSON Data를 적도록 되어있습니다. 우측에 JSON (application/json) 선택을 하게 되면 자동으로 Header에 Content-Type이 application/json이 추가되어 호출됩니다. (다른 Http Header 정보들도 해당 탭에서 추가하실 수 있습니다.)

  GET과 POST 방식의 호출 외에도 REST API에서 사용되는 DELETE, PUT 등의 Method도 지원합니다.

Postman 활용 방법

  위의 방법만 사용한다면 Postman 외에도 많은 Testing tool이 있습니다. 하지만 Postman만의 기능으로 유용한 기능 몇 개만 추려 소개하겠습니다. 가장 많이 사용하게 될 Collections, Code generate, Manage environments, Interceptor 4가지 기능입니다. (그 외에도 Team Library, API Monitoring 등 다양한 기능이 있지만 기회가 되면 다음에 작성하도록 하겠습니다.)

  1) Collections (https://www.getpostman.com/docs/collections)

  Collections will take your productivity to the next level. 설명 그대로 생산성을 한 단계 높여주는데 큰 역할을 합니다.

Postman에서 사용하는 Bookmark 기능이라고 생각하시면 되고, 사용법도 매우 간단합니다. (물론 Sync 기능도 제공됩니다.)

Save는 이미 등록된 Collection을 저장할 때 사용하고, Save as는 새로 저장할 때 사용합니다.

Request name : 요청 이름 (주로 어떤 역할을 하는 API인지 적어놓습니다.)

Create new collection : 이미 등록된 collection이 있는 경우는 선택창이 뜨지만, 새로 등록하는 경우 등록할 Collection 명을 적습니다. (카테고리 개념으로 접근하시면 됩니다.)

Collection이 등록된 모습 (Collection을 development / production로 나눌 필요는 없습니다. 주로 회원 API / 컨텐츠 API 등 업무별로 처리하며, 개발환경과 상용환경을 분리하는 방법은 이후 Manage environments에서 설명하겠습니다.)

  2) Code generate (https://www.getpostman.com/docs/code_snippets)

  Postman의 Code generate 기능을 사용한다면 다양한 언어별로 해당 API를 호출하는 source code를 생성해줍니다.

  

   사용법은 매우 간단합니다. API를 정상적으로 호출 한 뒤, 우측 Code 버튼을 클릭하게 되면 다양한 언어로 code가 생성되는 것을 확인 할 수 있습니다.

  3) Manage environments (https://www.getpostman.com/docs/environments)

  API를 개발하다 보면 local, development, production 환경에서 각각 다르게 호출해야 하는 경우가 생깁니다. 일반적으로 hostname이 다른 경우가 많은데, 예제로 hostname을 변수로 관리하는 과정을 소개하겠습니다.

  우측 설정버튼을 통해서 Manage Environments로 접근합니다.

  

  우측 ADD 버튼을 클릭 후 local에서 사용할 hostname을 정의합니다. 환경별로 호출할 Parameter가 다른 경우도 관리할 수 있습니다. 위의 방법과 동일하게 각각 환경별로 hostname을 추가하면 됩니다.

  샘플로 local과 prod를 추가하였고, URI 위치에 {{변수명}} 형태로 호출을 할 수 있습니다. (실제 존재하지 않는 API지만 정상적으로 호출은 되었습니다.)

  변수값을 관리하지 않는다면 API 개수 * 테스트환경 숫자로 Collection을 관리하고, 수정이 일어난다면 각각 수정해주어야 하지만, 위의 기능을 잘 활용한다면 1개의 Collection으로 모든 환경울 커버할 수 있습니다. hostname 뿐만 아니라 각 환경별 로그인 정보 등 header / body 탭에도 활용 가능합니다.

  4) Interceptor (https://www.getpostman.com/docs/capture)

  Interceptor 기능은 chrome 브라우저를 이용하여 브라우저 내에서 발생한 Request에 대해 자동으로 Postman History에 등록해주는 기능을 가집니다.

  https://chrome.google.com/webstore/detail/postman-interceptor/aicmkgpgakddgnaphhhpliifpcfhicfo 에서 확장 프로그램을 설치한 뒤 우측 상단에서 Request Capture를 활성화시켜 줍니다. 이후 Postman Application에 상단 Interceptor도 활성화시켜 줍니다.

           

  브라우저에서 google 검색 후 등록된 history 목록입니다. 검색 Request 외에도 브라우저에서 발생한 Request들이 등록 됩니다.

  위의 기능을 활용하면 특정 API를 분석, 이용하고 싶을 때 개발자 도구를 통해 값을 일일이 복사하지 않아도 됩니다. 또한 예를 들어 Web scraping 기능을 개발하려고 할 때 로그인 기능부터 원하는 데이터를 얻을 때까지 전체 flow를 브라우저를 통해 한 바퀴 돌아보고 얻어지는 history로 분석하여 개발을 시작하는 데에도 활용 가능합니다.

출처: http://devkyeol.tistory.com/entry/Postman-개요-설치-사용법-활용-방법 [kyeolee]