백앤드 개발자가 API를 늦게 만들어준다면, Postman(포스트맨) API 테스트 team 인터페이스 공유 mock server 구성하기

프로젝트 하다보면 선행조건으로 나와야하는 API 를 공유 받아야할때가 있는데 사람이 일하는거라서 

 

RestAPI 만들고 Swagger UI API를통해서 공유를 많이하게되는데 

가끔 서버개발 일정이 늦어지거나 내가원하는 Mock데이터가 충분하지 않아서 테스트 해보고싶은데 시간이 오래걸리는상황이라면 Postman Tool을 이용해서 간단하게 개발에 편리하게 이용할수 있는 기능이 있어서 공유 드립니다.

 

Postman 소개 & 사용법

관련 링크 : https://www.postman.com/downloads/postman-agent/

Postman Agent: For Mac, Windows, & Linux

Postman 은 두가지 workspace로 구분됩니다.

Personal, Team 개인, 팀 단위로 사용할수 있는 API console 이며 Team Workspace의 경우 3명까지 무료 입니다. 

team으로 사용시 API변경시 공유가 된다는장점이 있지만 그냥 개인으로 사용하고 File을 import 하셔도 됩니다.

같이일하는 3명으로 그룹핑 해서 각자 Team용으로 생성해서 사용하셔도됩니다.

 

사용하시는 OS에 맞게 다운로드 하시면됩니다.

Dashbard 화면

계정정보 ,workspace, 사용했던 이력들 확인이 가능합니다.

 

가볍게 사용해보시면 아시겠지만 API 생성,호출을 기본으로 사용할수 있고 

필요하다면 API팀공유 (3명까지 무료), Mock Server 구성이 가능합니다.

Collections

Postman 기능으로 생성하거나 import한  API항목을 볼수 있습니다.

 

APIs

이건 정확히 모르겠는데 위에 내용과 동일한것같은데 약간다른점은 Request, Response 좀더 Swagger UI 명세서처럼 볼수 있는 기능입니다.

 

Environments

API에서 사용되는 변수를 설정할수 있습니다. dev, stage, prod 환경에 따라 다라지는 Domain정보를 미리 변수로 생성해서 API에서 사용가능합니다.

 

Mock Servers

Mock Server 생성용도

 

Monitors

Api  상태와 성능을 지속적으로 시각화 한다고 합니다.

아직 사용을 안해봐서 ...

 

Flows

Flows는 API 흐름을 만들어 테스트할수 있는 기능입니다.

이것도 사용을 안해봐서 ..

 

History

그중에 팀공유와 Mock Server구성 공유드립니다.

 Postman Team API 공유하기

1.오른쪽 로그인 아이콘 클릭 > create Team 선택

2. Set Up Your Team 클릭

 

3.invite 버튼 클릭후 email 또는 참여링크 공유 (무료 최대 3명)

invite 버튼 클릭시 아래처럼 이름, 메일, 그룹이름 또는 초대 링크를 통해서 맴버 초대 가능

메일로 요청시 아래처럼 전달받을수 있습니다.

 

Postman Mock Server 구성 및 테스트

Postman 에서는 Mock Server 서버를 별도의 인프라 구축이나 설치 없이 사용이 가능합니다.

사용 방법은 간단합니다.

 

1. workspace 하위로 API 인터페이스를 생성 합니다.

2.API 인터페이스마다 추가적으로 Add example를 통해 원하는 Request 또는 Response를 생성할수 있습니다.

3. 왼쪽 메뉴중 Mock Server 선택 후 > New 버튼 클릭

여기서 Mock Server를 선택해주세요

 

4.Mock Server구성할 Workspace를 선택해주세요

여러개의 workspace를 구성하셨다면 Add example를 생성한 API  workspace를 선택해주시면됩니다.

5. workspace  선택후 mock server  이름 생성후 Create Mock Server 클릭하시면 생성됩니다.

6.생성된 "test mock server" 이름 을 선택후 View Collection 클릭하시면 workspace에 있는 API항목들이 나오고 앞에 도메인을 방금 생성된 mock server 도메인으로 변경해서 클릭하시면 정상적으로 Api에 추가한 Add example 에 Request, Response 를 확인할수 있습니다.

7. Collctions에 등록된 API를 직접 호출하면 정상적으로 Response  되는 Mock 데이터 확인이 가능합니다.

포스트맨을 통한 API 문서화 및 Mock Server 구성에 대해서 공유드립니다.