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

이번 게시물에서는 REST API 테스트용 프로그램인 Postman(포스트맨)을 설치하고, 포켓몬스터 API를 이용해서 간단하게 사용법을 알아봅시다.

먼저 포켓몬스터 API를 제공하는 http://pokeapi.co 를 방문해서 도대체 어떤 API인지 한번 살펴봅시다.

화면에 "Try it now!"라고 보이는 부분을 한번 봅시다. https://pokeapi.co/api/v2/는 API BASE로 변하지 않는 부분이고 pokemon/ditto/(ditto는 메타몽의 영문이름입니다)는 원하는 데이터를 부를 수 있는 url입니다. 우리가 바꿀 수 있는 부분이죠. 피카츄에 대한 정보를 알고 싶다면 pokemon/pikachu/를 입력하고 submit을 누르면 됩니다.

그 밑으로 Resource for ditto에서 API의 실행 결과, 즉 메타몽에 대한 정보들을 보여주고 있습니다.

실행 결과에서 세모버튼들을 눌러서 단순화 시켜봤습니다. 키, 몸무게, 이름, 기술, 이미지데이터(sprites)등의 정보를 보여주고 있습니다. 즉 url을 조작해서 원하는 데이터를 얻는 것이 REST API인데, REST API를 처음 접하시는 분들은 이걸로 뭘 어떻게 하는건지 궁금하실 겁니다. 또, 이게 웹사이트랑 뭐가 다른지도 궁금하실 겁니다.

"View raw JSON"을 눌러봅시다.

사실 처음 보여준 결과 화면은 사람이 보기 쉽게 변환된 화면이고, 이 데이터가 실제 API가 return하는 형식입니다. JSON 형식으로 데이터를 전달해 주기 때문에 내가 작성하는 프로그램에서 해당 데이터를 받아서 바로 변수에 넣어서 사용한다거나 할 수 있는 것입니다. 즉 API를 사용하면 데이터를 프로그램이 바로 사용할 수 있는 형태로 주고 받을 수 있습니다. 철저히 프로그램을 위한 소통방식이에요.

포스트맨은 이 사이트의 'Try it now!'와 같이 API를 테스트하는 프로그램입니다. 위 pokeapi.co 사이트의 Try it now!는 pokeapi의 api만 테스트할 수 있지만, 포스트맨은 어떠한 API라도 테스트할 수 있으며 좀 더 복잡한 작업도 할 수 있습니다.

서론이 좀 길었는데요, https://getpostman.com 에서 포스트맨을 다운받아 설치해 봅시다.

포스트맨을 실행하면 아래와 같이 로그인 화면이 뜹니다.

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

처음 실행화면입니다. 화면 중앙 상단부에 Lunchpad라는 탭이 열려있는데, 오른쪽에 +버튼을 눌러서 새로운 탭을 열어줍니다.

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

피카츄에 대한 정보가 표시됩니다.

사실 위 url을 그냥 일반 브라우저에 입력해도 동일한 정보가 출력됩니다. 브라우저가 기본적으로 GET을 사용해서 요청을 보내기 때문입니다.

이번엔 GET이 아닌 POST를 보내는 방법을 알아보겠습니다. 사실 이 포켓몬 API는 POST를 지원하지 않기때문에 의미있는 결과를 보기는 힘들지만, 포스트맨을 연습하기 위한 목적으로 POST API에 JSON 데이터를 보내는 방법만 한번 연습해 봅시다.

GET을 POST로 바꾸어 주고 body탭을 눌러서 raw type을 선택하였습니다. raw 타입은 JSON으로 해 줍니다. 그 밑에 전송할 JSON 데이터를 입력한 후 send를 보내면 됩니다. body에 들어갈 내용과 형식은 API 제작자 마음입니다. 그러므로 API를 제대로 사용하기 위해서는 API 문서 및 spec을 정확하게 알아야 하며, API 제작자는 이용자에게 정확한 문서 및 spec을 제공해야 합니다.

다음으로 연습했던 request를 저장하는 방법을 알아봅시다. 어플리키이션을 개발하다 보면 사용하는 API의 수가 늘어나는데, 잘 정리해서 보관하는 것이 중요합니다.

Send 버튼 옆에 Save 버튼을 누르면 현재 request를 저장할 수 있는 창이 뜹니다. 이름과 설명을 입력해서 정리해 둡시다. API는 바로 저장 할 수 없고, collection을 만든 후 그 안에 저장할 수 있습니다. "Create Collection"을 누르고 이름을 입력하여 collection을 먼저 생성한 후에  Save 버튼을 누를 수 있습니다.

왼쪽 사이드 바에서 Collections을 누르면 에 내가 저장한 API가 보입니다.

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

댓글

댓글쓰기

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

UP