[Postman] API 테스트 도구 Postman 설치 및 테스트 API 요청하기

Postman ?

개발된 API를 테스트하여 문서화 또는 공유 할 수 있도록 도와 주는 플랫폼이다.

Postman은 모든 API 개발자를 위해서 다양한 기능을 제공한다. 변수 및 환경, request 설명, 테스트 및 사전 요청에 필요한 스크립트 작성 등 Postman은 현재 워크 플로우를 더 효율적으로 만들 수 있도록 고안되었다.

 

URL을 통해서 테스트를 하는것은 한계가 있다. 실제로 개발할 경우, 클라이언트에서 버튼을 만들고, 이벤트를 만들고, 버튼에 이벤트를 등록하고, 버튼을 누르면 해당 이벤트를 실행하고, 이벤트에서는 요청을 하고, 요청을 한 이후에는 응답을 받고, 그 응답을 받은 내용을 화면에 출력하는 등의 작업이 너무 길어지게 된다.

Authorization이나 Header, Body를 수정하는건 더더욱 제한이 많다. 하지만 포스트맨은 해당 작업을 할 수 있도록 인터페이스를 구축해놓은 툴이기 때문에 누구나 쉽게 사용이 가능하다. 또한 OS에 상관없이 어디에서나 사용이 가능하고, 가벼운 툴이여서 가용성이 뛰어 나다. 계정을 보유하고 있다면, 내가 요청한 Request 히스토리, 테스트한 환경을 그대로 저장되기 때문에 언제 어디서나 내가 작업했던 환경이 구축된다는 특징이 있다.

 

Postsman 설치

 

포스트맨 다운로드 접속

Download Postman | Get Started for Free

Windows 64-bit 클릭 설치파일 다운로드

 

계정을 보유하고 있다면, 내가 요청한 히스토리, 테스트한 환경 등을 그대로 저장된다. 

계정이 있다면 바로 Sign in 클릭하면 된다.

 

 

Create Free Account 클릭했을 경우 계정을 생성해주면 된다.

Sign up with Google 은 간편하게 계정 생성하기 용이하다.

 

 

로그인했을 때 기본 홈 화면이다.

 

 

 

테스트용 API

 

요청하고 응답받을 API 서버가 없다면, 간단하게 HTTP 요청/응답 동작을 확인할 수 있는 도메인이있다.

요청방식	GET	POST	PUT	DELETE
URL	https://httpbin.org/get	https://httpbin.org/post	https://httpbin.org/put	https://httpbin.org/delete

 

API 실행

Workspaces 생성

 

Workspace

포스트맨의 모든 기능을 담고 있는 뷰

• Personal workspace와 Team workspace로 구분가능
• workspace의 단위는 목적에 따라 자유롭게 지정
  • 기능별: 업무 기능에 따라 클러스터링 한다.
    • QA는 테스트 작성을 위한 workspace를 가지고, 기술자는 API를 문서화하기 위한 workspace를 가진다.
  • 제품 또는 프로젝트별: 제품이나 프로젝트별로 구성하게 되면 해당 서비스와 관련된 모든 것들이 해당 workspace 내에 있으므로, 해당 제품에 대한 작업을 시작했을 때 맞춤 view를 볼 수 있다.
  • 파트너 별: 외부 파트너나 고객과 통합하여 구축하는 경우 권한을 제어하여 workspace에 참여할 수 있도록 한다.

 

 

Collection 및 Request 생성

 

Collection

• Collection은 request를 그룹화한 단위
• 모든 요청은 Collection에 포함되어 있어야 한다.
• Collection에 속한 모든 요청에 대해 통합 테스트를 실행할 수 있다.

Request

• 실제로 API에 대한 테스트를 진행하기 위해서는 Request를 생성해주어야 한다.
• 기본 untitled request 생성된다.

Response

• Postman을 사용하는 이유는 프론트엔드를 배제하고, 서버 프로그램이 들어온 API 요청에 대해서 제대로 동작하는지 확인하기 위해
• 요청에 대한 결과는 하단의 Response로 들어오게 된다.
• Collection 내에 저장하거나 json 파일로 다운로드 할 수 있다.
• Response는 body와 header, 상태코드로 구성되며, HTTP 기본 스펙을 포함하고 있다.
• Pretty의 경우 JSON이나 XML 응답을 좀 더 보기 편하도록 출력해준다.

 

 

테스트용 HTTP API 항목의 GET 방식 URL을 입력 후 Send 클릭