Postman으로 API 테스트 시 알아야 할 점

파라미터 추가하기

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

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:

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