API 테스트 프로그램(Postman) 설치및 간단 사용법

API는 Application Programming Interface의 약자로 프로그램이 다른 프로그램과 명령을 주고 받을 수 있는 방법 중의 하나입니다. API에 대한 자세한 설명은 토막글/API에서 읽어주시고 Node JS API 항목에서는 Node JS, Express를 사용하여 REST API를 생성하는 방법과 활용하는 방법에 대해 강의할 예정입니다.

이번 게시물에서는 REST API 테스트용 프로그램인 Postman(포스트맨)을 설치하고 간단하게 사용법을 알아보겠습니다.

포스트맨은 다운로드받아서 컴퓨터에 설치할 수 있는 버전과 웹 브라우저의 확장 프로그램으로 설치할 수 있는 버전이 있습니다. 저는 크롬 브라우저의 확장 프로그램으로 다운받아 설치하겠습니다.

https://chrome.google.com/webstore 로 이동하여 검색창에  postman을 입력하고 앱(app)에서 검색합니다.

크롬 앱스토어에서 포스트맨(Postman) 검색하기

설치가 완료된 후 크롬브라우저에 chrome://apps 를 입력하면 postman 확장 프로그램이 설치되어 있는 것을 볼 수 있습니다. 클릭하여 실행해 줍니다.

크롬에서 확장프로그램(앱) 목록 열기

처음 실행하면 아래와 같이 로그인 화면이 뜨는데, 아래의 "Take me straight to the app"를 클릭하면 계정을 생성하지 않고 실행할 수 있습니다. 계정을 생성하면 모든 작업이 온라인에 저장되어 다른 컴퓨터에서 해당 계정으로 로그인 시 기존 작업환경을 불러 올 수 있습니다.

포스트맨(Postman) 로그인 화면

지금은 제작한 API가 없으니, 다른 공개된 API를 사용해서 포스트맨 간단 사용법을 알아보겠습니다. 우리가 사용할 API는 포켓몬 정보를 알려주는 API로 http://pokeapi.co 에서 제공하고 있습니다  (사족: 포켓몬은 영어로 pokemon입니다). 이 사이트 상단 오른쪽의 Document 메뉴를 클릭하면 모든 API 리스트와 설명을 볼 수 있으며, 우리는 이 중 하나의 포켓몬에 대한 정보를 읽어오는 API를 테스트하겠습니다.

아래 스크린샷의 왼쪽 첫번째 빨간 박스는 HTTP verb를 입력하는 곳이며, 두번째 박스는 REST API의 URL 을 입력하는 곳입니다. HTTP verb는 GET을 선택하고 URL은 http://pokeapi.co/api/v2/pokemon/pikachu/를 입력한 후 Send를 누릅시다.

포스트맨(Postman) GET 사용 예제

피카츄에 대한 정보가 나오는 것을 볼 수 있습니다. 위 API를 사용하면 내 DB에 포켓몬 정보가 없어도 포켓몬 사이트를 만들 수 있겠지요.

사실 위 url을 그냥 일반 브라우저에 입력해도 동일한 정보가 출력됩니다. 브라우저가 기본적으로 GET을 사용해서 요청을 보내기 때문입니다. 이번엔 GET이 아닌 POST를 보내는 방법을 알아보겠습니다. 사실 이 포켓몬 API는 POST를 지원하지 않기때문에 의미있는 결과를 보기는 힘들지만, 포스트맨을 연습하기 위한 목적으로 POST를 어떻게 보내는지만 알아보겠습니다.

포스트맨(Postman) POST 사용 예제

위 스크린샷 처럼 GET을 POST로 바꾸어 줍니다. 그러면 GET이었을때는 비활성화되어 있던 body탭(왼쪽 두번째 빨간 박스)이 활성화됩니다. body는 서버로 전달할 정보를 담고 있는 부분입니다. GET은 정보를 요청하는 HTTP verb이기 때문에 body가 없지만 POST는 정보를 전달하는 HTTP verb이기 때문에 body에 내용을 추가할 수 있습니다. body에 들어갈 내용과 형식은 API 제작자 마음입니다. 그러므로 API를 제대로 사용하기 위해서는 API 문서 및 spec을 정확하게 알아야 하며, API 제작자는 이용자에게 정확한 문서 및 spec을 제공해야 합니다.

우리는 그냥 json 형식으로 아무 정보나 보내보겠습니다. 포스트맨에서 json 형식으로 정보를 보내기 위해서는 body 탭에서 raw(왼쪽 세번째 빨간 박스)을 선택하면 drop down이 생기는데 여기서 json을 선택(왼쪽 네번째 빨간 박스)를 선택한 후 보낼 내용을 json형태로 입력하면 됩니다. 그 다음 send를 보내면 {"detail": "Method \"POST\" not allowed."}라는 값이 돌아옵니다.

다음으로 연습했던 API를 저장하는 방법을 알아보겠습니다. 

포스트맨(Postman) API 저장 및 콜렉션(collection) 생성하기1

포스트맨에서 API는 collections에 저장되어야 합니다. 오른쪽 상단의 save버튼을 누르고 "Create Collection"을 누르면 새로운 collection을 만들 수 있습니다. 이름을 입력한 후에 엔터키를 눌러서 collection을 만든 후 save버튼을 누르면 API가 저장되어 다음번에 다시 사용할 수 있습니다.

포스트맨(Postman) API 저장 및 콜렉션(collection) 생성하기2

왼쪽 사이드 바에 내가 저장한 API가 보입니다. 

이 게시물에서는 포스트맨의 아주 기본적인 사용방법만 설명하였습니다. 다른 많은 유용한 기능들이 이 게시물에서는 설명되지 않았지만, 제 강의를 진행하는데는 쓰이지 않으므로 생략했습니다. 궁금하신 분은 개별적으로 검색을 해서 공부를 하시기 바랍니다.

댓글

댓글쓰기

이 글에 댓글을 다시려면 SNS 계정으로 로그인하세요. 자세히 알아보기

UP