[Postman] API 개발을 위한 HTTP 통신 테스트

Postman

개발중인 API를 테스트 할 수 있는 플랫폼인

Postman에 대해서 알아보자

---

Postman이란?

• API를 개발할 때 요청을 보내고 응답을 받는 과정을 테스트해볼 수 있다.
• 설치하기
  - 포스트맨 공식사이트 :  https://www.postman.com/
  - 로그인 후 Download the desktop app for 윈도우 클릭하여 설치
• 용어
  - Workspaces : 팀, 개인 등 다양하게 설정 가능
  - Collection : 다양한 요청들을 저장할 수 있는 단위(폴더의 개념)
  - Request : 하나의 API 요청을 보낼 수 있는 단위
  - Response : 요청에 대한 결과
• 사용하기
  1. 새로운 Request를 만든 후 Get / Post 등의 메소드를 선택한다. 
  2. 테스트 하고자 하는 http://localhost:포트번호/url매핑값 을 입력한다.
  3. API 설정에 따라 적절하게 요청시 전달값을 보낸다(하단 참고)

 

---

데이터 주고받기

167번 포스팅에서 HTTP메소드에 대해 대략적으로 알아봤다.

Postman에서 이 규칙에 맞춰서 요청을 보내고 받는 방법을 알아본다

---

GET / DELETE 메소드

• URL에 데이터를 담는 메소드이다.
• PathVariable 방법
  - 스프링에서 @PathVariable로 로직을 짠다.
  - API 규칙에 맞춰 URL에 원하는 데이터를 담아 보낸다.
• QueryString 방법
  - URL에 '?키값=밸류값&키값=밸류값' 을 직접 입력해도 되지만,
    [Params]에서 키값과 밸류값을 넣으면 URL을 자동완성 시켜준다.

 

 

POST / PUT 메소드

• Body에 데이터를 담는 메소드이다
  >> [Body] 탭에서 바디 데이터 유형(Content Type)을 선택한 후 키밸류 값을 넣어준다.
• JSON 으로 보내기
  - [Body] - [raw] - JSON 으로 선택해준다.
    { "키값" : "데이터", "키값2" : "데이터2", .. } 의 JSON 형태로 데이터를 전달한다.
  - 자바에서 @RequestBody로 데이터를 받아야 한다(커맨드 객체/변수에 매핑시킨다)
• form-data 로 보내기
  - [Body] - [form-data] 에서 키/밸류 값을 입력한다.
  - form태그의 전달값을 받기 위한 형태이다.
  - input type=file 로 전달된 데이터는 스프링에서 MultipartFiles 타입으로 받아야한다.

 

 

결과값 확인하기

• Pretty : Json등의 리턴값을 보기 좋게 정리해준다
• Raw : 리턴값 그대로를 보여준다.
• Preview : 태그 등이 포함된 리턴값이 있을 경우 미리보기를 지원한다.
• Visualize : 사용하기 위해서는 별도의 처리가 필요하다.