포스트맨 (postman) 사용법

포스트맨을 이용한다면

대상 URL에 요청할 메소드를 지정할 수 있고, 호출에 필요한 파라미터의 전달방식을 설정할 수 있으며, 결과 또한 빠르게 확인이 가능하다.

 

1. 포스트맨 다운로드

https://www.postman.com 

Postman API Platform | Sign Up for Free

 

2. 테스트용 API 준비

요청하고 응답받을 API 서비스가 필요하다.

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

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

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

httpbin.org

 

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

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

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

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

 

4. 대상 API 추가하기

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

 

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

 

스크롤을 아래로 내려 Collection 명을 정하고 체크버튼 후,  save

 

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

 

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

각각의 요청방식과 URL을 입력한 후, Send 버튼 클릭..

아래 빈 영역에 Response가 표시된다.

 

** 한 탭에서 요청방식과 URL을 바꿔가며 실행하여도 좋지만, (+)버튼으로 새탭을 열어서 요청정보를 추가할 수도 있다. 새로 연 탭은 Save 버튼으로 Collection에 저장이 가능하다.

 

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

 

 

6. 파라미터 추가하기

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

Prams 탭에서 Key와 Value 세트를 작성하여 Send를 클릭한다.

 

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

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

 

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

**사용빈도가 작은 GraphQL을 제외한 각각의 사용조건은 다음과 같다.

 

①  form-data

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

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

 

② x-www-form=unlencoded

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

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

 

③ raw

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

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

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

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

 

④ binary 

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

 

 

이상 POSTMAN(포스트맨) 기본사용방법이였습니다 ^^