[POSTMAN] 포스트맨 (POSTMAN) 사용법

포스트맨(POSTMAN)

• REST API 설계 개발, 테스팅을 할 수 있는 GUI 툴로 개발 생산성을 높여주는 프로그램
• 팀원들 간의 공유 기능
• Query String이 포함된 GET 방식 호출
• JSON이 사용된 POST 방식 호출
• Authorization을 이요한 oauth 요청
• 계정 별로 API 사용에 대한 내용과 기록을 저장할 수 있습니다.
• 테스트한 API의 입력 정보를 기록하고 저장할 수 있습니다. Save As... 클릭하기
• 개발 중인 앱에 회원가입, 로그인, 로그아웃, 포스트 등을 구현하고 테스트 하기 위해서는 클라이언트가 필요합니다.
• 클라이언트에서 특정 주소로 보내준 정보와 요청을 토대로 서버에 구현한 로직을 처리하기 위해서입니다.
• 예를 들어 회원가입이라면 localhost::PORT/api/user/register라는 라우터로 이메일, 비밀번호 등의 정보를 보냅니다.
• 서버는 이 정보를 받아서 회원을 만들어 데이터베이스에 저장해야 합니다.
• 하지만 특정 주소로 정보를 보내줄 클라이언트(프론트 엔드)가 아직 개발되지 않았다면 포스트맨이라는 프로그램으로 쉽게 테스트 할 수 있습니다.

사용법

1. Workspances 생성
2. [+} 버튼 클릭
3. GET or POST 요청

• Paramse
  • QueryString으로 요청 파라미터 설정
• Authrization
  • API 인증을 위해 OAuth 2.0/ API Key / Bearer Token 지원
• Headers
  • 요청 헤더에 정보를 설정할 수 있습니다.
• Body
  • form-data, json, text, xml 등의 데이터 타입 요청 파라미터로 설정할 수 있습니다.
• Pre-request sqript
  • 요청을 보내기 전에 특정 스크립트를 작성하여 미리 만들어 놓은 요청들을 순서대로 실행하여 시나리오 실행이 가능합니다.

코드 스니펫(Code snippet)

• 포스트맨은 다양한 언어들을 이용해서 어떻게 해당 데이터를 받아 올 수 있는지 알려줍니다.
• NodeJs, Java, Python, JavaScript, ...

Workspace

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

Collection

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

Request

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

Response

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

API 테스트?

• API 테스트는 애플리케이션에 적용한 API가 정상 작동하는지 확인하는 테스트입니다.
• 웹 API의 경우 키, 값을 URL을 request하면 값이 반환됩니다.
• 제대로 된 Resopne 값이 반환되는지 확인합니다.
• Value를 잘못 입력했을 때 올바른 오류 값이 리턴되는지 확인합니다.

 

 

 

REFERENCE

https://blog.naver.com/PostView.naver?blogId=hj_kim97&logNo=222411920039 

[Rest Client 툴]포스트맨(POSTMAN) 설치 및 사용법

https://onlydev.tistory.com/84

포스트맨(Postman) 사용법과 다운로드(feat. 유튜브 API)

https://bono915.tistory.com/entry/Postman-Rest-API-%ED%88%B4-%EC%86%8C%EA%B0%9C-%EB%B0%8F-%EC%82%AC%EC%9A%A9%EB%B2%95

[Postman] Rest API 툴 소개 및 사용법

https://kellis.tistory.com/17

[Postman 사용법] 1. 환경 설정 (Workspace와 Collection)

https://authorkim0921.tistory.com/22

포스트맨(Postman)으로 API 테스트

https://it-learning.tistory.com/224

포스트맨(postman) 사용법 (서버 개발, 백엔드)