Postman(이하 포스트맨)
은 REST API 개발에서 사용되는 협업 프로그램입니다.
API를 개발하고 URL에 일일이 요청을 보내거나, 테스트를 위해 프론트엔드를 따로 만들거나, 프론트엔드 완성까지 기다려야한다면 무척이나 비효율적이겠죠?
포스트맨은 API를 개발과정에서 요청(URL, Header, Body, parameter 등)을 보내고 응답 확인, 테스트, 디버깅 등의 다양한 편의 시스템을 제공하고 있습니다.
백엔드 기준으로 설명드렸는데요. 프론트엔드에서도 백엔드로부터 응답을 받아와서 어떤식으로 화면을 구성할지 도움을 받는 식으로도 사용을 할 수도 있습니다.
포스트맨은 공식 홈페이지에서 다운로드 할 수 있습니다.
설치 및 가입/로그인 후 실행하면 다음과 같은 화면이 나옵니다.
좌상단의 +
버튼을 클릭하면 다음과 같은 화면이 나타납니다. 포스트맨을 사용하시려고 생각했다면 기본적인 사항을 알고 있다는 전제하에 설명드리도록 하겠습니다.
각 HTTP 요청 메소드, 요청 URL, 쿼리 파라미터
를 입력하고 send
버튼을 클릭하면 입력된 정보를 기반으로 요청이 발송됩니다.
한 번 더미데이터를 가지고 확인해보겠습니다.
https://jsonplaceholder.typicode.com라는 가짜 API 제공 사이트를 이용했습니다.
요청 메소드와 URL을 적고 전송했더니 200 OK 상태 코드와 함께 더미 응답이 도착했습니다.
이런식으로 테스트 환경에서 빠르고 간단하게 API를 테스트 해볼 수 있습니다.
Request
는 API 요청을 작성할 수 있는 공간입니다. 상기했듯이 HTTP 요청 메소드, 요청 URL, 파라미터, 헤더 등 여러 정보를 담아서 Send를 할 수 있고, 그에 대한 결과는 아래 Response 칸에 나타나게 됩니다.
포스트맨의 작업 최소 단위라고 보시면 될 것 같습니다.
Workspace
는 프로젝트 단위(팀 혹은 개인)으로 API 요청 작업을 구성하고 싶을때 만들어줍니다.
이런식으로 워크스페이스를 생성할 때 사용 목적에 따라 다양한 생성 옵션들을 제공하고 있습니다.
Collection
은 요청들을 분류해서 모아놓을 수 있는 기능입니다.
Collection에 들어있는 요청들에 대해 한 번에 요청을 보내거나 응답받을 수 있고, API를 나눠서 관리하기 때문에 API의 용도나 사용법을 알 수 있게 됩니다.
Folder
는 Collection 하위에서 각 요청들을 논리적 구분을 하기 위해 생각하는 폴더입니다.
ex)
member_service라는 프로젝트 진행에서member_service_backend
라는 콜렉션과member_service_frontend
라는 콜렉션으로 나누고 각 콜렉션 하위에auth, members
등의 폴더가 있으며, 해당 폴더 내에 실제 요청들이 나뉘어서 정리되어 있다라는 개념으로 사용됩니다.