포스트맨(Postman) 사용 방법

개발하다보면 api 호출을 위해서 다양한 도구들을 사용한다.
저는 실무에서 Postman 도구를 사용하여 api 호출 및 api 자동화 테스트 스크립트, 배치성 테스트 등 다양한 방면으로 사용을 하고 있습니다. 참 유용한 도구인거 같습니다.
Postman 사용 방법이랑 실무에서 어떻게 쓰이고 있는 공유드리고자 합니다.

 

포스트맨 설치

아래 링크 들어가셔서 OS에 맞는 설치 파일 다운받고 실행해서 설치해주시면 됩니다.

https://www.postman.com/downloads/

Download Postman | Get Started for Free

 

정상적으로 설치가 완료됐다면 아래 홈 화면이 보이실 겁니다.

여기서 상단에 Workspaces - Create workspace를 클릭해서 workspace를 만듭시다.

workspace를 만들게 되면 다음과 같이 작업을 할 수 있는 화면이 나옵니다.

기능들에 대해서 간단하게 설명 드리겠습니다.

1. Collections : 요청할 api들을 만들고 관리하는 공간입니다. 
2. APIs : 포스트맨에 정의된 컬렉션 및 환경 변수, Mock Servers를 버전 별로 관리할 수 있는 기능입니다.
3. Environments : api에서 사용할 환경 변수들을 관리하는 공간입니다.
4. Mock Servers : 요청할 api가 준비되어 있지 않을 때 가짜 api를 만들 수 있습니다.
5. Monitors : 컬렉션을 스케쥴 예약으로 실행시키면서 컬렉션 내에 api호출을 모니터할 수 있는 기능입니다.
6. Flows : 요청을 논리적으로 연결하여 실제 프로세스를 테스트하는 데 도움을 줍니다.
7. History : api 호출에 대한 히스토리를 확인할 수 있습니다.

 

API 요청 만들기

간단하게 네이버 뉴스 검색 api를 요청해보겠습니다.

 

먼저 api를 보관할 컬렉션을 만들겠습니다. (컬렉션을 사용하는 이유는 프로젝트 별로 api를 관리할 때 사용합니다. 환경 변수 설정, 모니터 기능에서도 컬렉션 별로 지정할 수 있기 때문에 프로젝트 별로 분리해서 관리하는 것이 좋습니다.) 

 

1. + 버튼을 눌러서 컬렉션을 만든다.

2.  ... 클릭해서 Add request를 클릭합니다.

3. 메소드 선택하고 요청할 URL 작성하고 호출해주면 요청 API 만들기 완성입니다.

(url에 파라미터를 입력하게 되면 자동으로 Params에 생성됩니다.)

또는 인증이나 헤더, 바디에 요청에 필요한  파라미터를 추가해서 요청하실 수 있습니다. (api 명세를 보고 맞게 요청하시면 됩니다.)

 

간단하게 포스트맨으로 요청 api 생성하는 방법에 대해서 알아봤습니다.

실무에서 api 테스트를 위해서 꼭 필요하고 유용한 툴이기 때문에 백엔드, 프론트 엔드 개발자라면 알고 계시는게 좋을거 같습니다.