포스트맨(Postman) 사용법과 API 실행해 보기

포스트맨의 사용방법과 이를 이용하여 API를 실행하여 테스트 하는 방법에 대해 소개한다.

 

API에 요청을 보내고 결과를 확인하고 싶을 때, 브라우저에 직접 API URL을 작성하여 결과를 확인할 수 있다.

그러나 이런 방법으로는 GET 방식 요청을 보내거나 하는 등의 간단한 요청에 한해서만 가능하다.

 

하지만 포스트맨을 이용한다면

대상 URL에 요청할 메소드를 지정할 수 있고, 호출에 필요한 파라미터의 전달 방식을 설정할 수 있으며,

결과 또한 빠르게 확인이 가능하다.

 

한 번 다운로드 받아두면 사용하기도 쉽고 굉장히 유용한 프로그램이니

이참에 계정등록하고 다운로드하면 좋을 듯 하다.

 

<차례> 1. 포스트맨 다운로드 2. 테스트용 API 준비 3. 포스트맨 실행, 화면 구성 확인 4. 대상 API 추가 하기 5. API 실행하고 결과 확인하기 6. 파라미터 추가하기

 

1. 포스트맨 다운로드

https://www.postman.com/

↑여기서!

 

2. 테스트용 API 준비

포스트맨을 사용해 보기에 앞서, 요청하고 응답받을 API 서비스가 필요한데

간단하게 HTTP request와 response의 동작을 확인할 수 있도록 서비스를 제공해 주는 도메인이 있다.

이 서비스를 이용하여 포스트맨으로 REST API를 테스트 하는 법을 알아보고자 한다.

(물론 구축해 둔 API 서버가 있거나 한다면 그 쪽을 이용해도 아무 문제 없다.)

홈페이지: https://httpbin.org/

요청방식	URL
GET	https://httpbin.org/get
POST	https://httpbin.org/post
PUT	https://httpbin.org/put
DELETE	https://httpbin.org/delete

 

3. 포스트맨 실행, 화면 구성 확인

기본적으로 좌측 영역의 Collections에 대상 API URL을 추가하고,

우측 메인 영역에서 세부 설정을 하고 실행하여 결과를 확인하는 방식으로 사용한다.

초기 화면

과거 기억에, 포스트맨은 크롬의 확장도구였으며 지금과 같이 Standalone 플랫폼은 아니었던 것 같다.

업데이트를 거듭하며 현재까지 오면서 다양한 기능들이 추가된 느낌인데,

이 포스팅에서는 "API 서버에 요청을 보내고 응답을 받는 방법을 확인 함"을 목표로 한다.

 

 

4. 대상 API 추가 하기

좌측 상단의 New를 클릭하고, 팝업 창에서는 Request를 선택한다.

 

Request name에 작업명을 임의대로 정한다.

 

스크롤을 아래로 내려 Collection명을 정하고 체크 버튼, Save 순으로 눌러 작성한다.

 

이것으로 API 요청을 보낼 준비가 끝났다.

 

5. API 실행하고 결과 확인하기

(1) 앞서 <2. 테스트용 API 준비> 항목에서 기재한 각각의 요청방식과 URL 짝에 맞게

    다음 캡쳐와 같이 메소드 설정, URL 입력을 하고 Send 버튼을 클릭해 본다.

① 메소드 변경 - ② URL 입력 - ③ Send 클릭 순서로 실행하면 아래 빈 영역에 Response가 표시된다.

 

(2) 한 탭에서 메소드와 URL을 바꿔가며 실행하여도 좋지만,

    (+) 버튼으로 새 탭을 열어서 요청정보를 추가할 수도 있다.

    새로 연 탭은 Save 버튼으로 Collection에 저장이 가능하다.

새 탭을 열고 post 요청을 보낸 결과 화면. 그리고 Save를 눌러 저장하면 왼쪽 Collection에도 추가가 된다.

 

이상이 포스트맨을 이용하여 요청과 응답을 확인하는 기본 동작 방법이다.

 

 

 

 

 

 

6. 파라미터 추가하기

잘 알려져 있다시피, 웹 페이지에서 파라미터를 넘긴다고 생각한다면

GET 방식일 때 URL에 붙이고, POST 방식일 때 form에 싸서 submit을 해 왔던 것을 기억할 것이다.

이를 포스트맨에서는 다음과 같이 설정한다.

 

(1) URL에 추가하기(주로 GET 방식)

Params 탭에서 Key와 Value 세트를 작성하여 Send를 클릭한다. 어렵지 않다.

 

(2) Requestbody에 추가하여 넘기기(주로 POST, PUT 등의 방식)

이 경우에는 Body 탭을 이용한다.

API 사양이 어떻게 정의되어 있냐에 따라 어떤 형식의 Body를 이용해야할지 결정해야한다.

사용 빈도가 극히 제한적일 것이라 생각되는 GraphQL을 제외한 각각의 사용 조건은 다음과 같다.

 

① form-data

명칭에서 볼 수 있듯이 웹 페이지에서 form 태그의 정보를 submit으로 넘길 때를 생각하면 된다.

Key - Value 조합으로 작성하며 파일 전송도 가능하다.

form-data의 사용

 

② x-www-form-unlencoded:

form-data 형식과 같으나, 영문자를 제외한 글자는 모두 인코딩 한다.

Key - Value 조합으로 작성하며 텍스트 타입 전송만 가능하다. (파일 전송 불가)

파일 전송이 되지 않을 뿐, form-data와 사용 방법은 같다.

 

③ raw:

파라미터 형식과 내용을 직접 작성하는 경우 이쪽을 택한다.

선택할 수 있는 옵션으로는 Text, JavaScript, JSON, HTML, XML이 있다.

※ Spring Boot로 구축한 REST API의 컨트롤러에서

   @Requestbody 어노테이션을 통해 파라미터를 받는 메소드라면 JSON을 선택하여 작성하는 것이 일반적이다.

JSON 형식으로 파라미터를 넘길 경우

 

④ binary:

파일을 전송할 때 사용된다.

 

 

🏆 마무리하며

API를 실행해 보기 위한 용도로서 사실 조금만 익숙해진다면 아주 유용한 툴이고 조작 방법도 그리 어렵지는 않다.

현재 REST API 서버 구축 포스팅도 같이 올려두고 있기에, 그 쪽 포스팅을 보고 오시는 분들을 위하여

참고가 될까 하는 마음에 겸사겸사 포스팅 해 보았다.

 

관련 글:

2020/09/06 - [프로그래밍/Spring Boot] - Spring Boot로 Rest API 서버 구축하기 - (1) 환경구축

 

 

※ REST API를 쉽게 구축할 수 있는 방법을 담은 전자책을 출시했습니다. ※

『2시간 안에 REST API 핵심 구축하는 방법』

kmong.com/gig/306406

REST API 구축 참고서 PDF 드립니다. | 10000원부터 시작 가능한 총 평점 0점의 취업·투잡, 전자책·노

 

🔑 조금 더 깊게 본다면

이 포스팅에서 참고하고 있는 테스트 API 서비스는 response에 다양한 정보를 출력해 주고 있다.

(설정한 파라미터의 정보, user-agent, 헤더 정보 등등)

이 포스팅에서는 단순히 포스트맨 사용법만 익혔지만, 연습해 보면서 이 API의 실행 결과인

response 정보도 확인 해보면 http 통신으로 주고받는 정보들이 이런 식으로 오가는구나 하고 참고도 될 듯 싶다.