[PostMan] API시뮬레이터 - Mock Server 만들기

안녕하세요.

오늘은 초기 개발 단계에 아주 유용한 PostMan의 Mock Server를 소개하겠습니다.

Mock Server는 가상 API서버를 제공해 주어 요청과 응답이 실제 처리되는 것처럼 시뮬레이션해 줍니다.

백엔드 환경이 완전히 구축되지 않았어도 사전에 합의된 API를 제공해 주어 지체 없이 바로 개발을 시작할 수 있게 도와줍니다.

 

1. 먼저 포스트맨을 실행시켜 주신 후 새로운 Collection을 생성해 줍니다.

 

2. 좌측에 Mock Servers 탭 선택 후 Create Mock Server 버튼 또는 + 버튼을 눌러줍니다.

 

3. Select An existing collection 탭을 눌러 아까 생성하신 Collection을 선택 후 Next를 눌러주세요.

 

4. Mock Server Name을 지정해 주시고, Save the mock server URL as an new environment variables 체크 후

Create Mock Server 버튼을 눌러 생성해 주세요.

 

5. Mock Server가 생성되었으면 https://~~~.mock.pstmn.io로 끝나는 URL주소를 복사해 주세요.

 

6. 다시 Collections 탭으로 돌아가 Add request로 새로운 요청을 하나 생성해 주세요.

 

7. 저는 user를 조회하는 mock API를 만든다고 가정하였습니다.

생성하신 request -> 우측 마우스 -> Add example을 눌러주세요.

 

이제 아래 API명세서를 기준으로 mock API 하나를 만들어보겠습니다.

user 조회 API
Request Path(URL)	/api/user/{userId}
HttpMethod	GET
Request Parameter	none
Headers	none
Response Body	{   "userId":"아이디",    "name":"이름",    "address":"주소" }

 

8. 여기서부터 mock API를 설정하는 단계입니다.

HttpMethod, URL, 요청 Parameter, Headers, 요청 Body, 응답 Body 등 상세한 설정을 하실 수 있습니다.

Base URL에 해당하는 {{url}}은 4번에서 Mock Server를 생성하면서 만들어진 URL이

자동으로 Environment에 추가되어 바로 사용할 수 있습니다.

 

test01 유저를 조회하면 상세정보인 이름(darren)과 주소(서울특별시)를 반환하게 됩니다.

저장 후 우측에 Try 버튼을 눌러주세요.

 

9. 아까 복사한 Base URL과 Path로 요청을 보내게 되면

위 사진처럼 Mock Server에서 요청을 처리하여 응답 값이 오는 것을 확인하실 수 있습니다.

또한 일반 브라우저에서도 Mock API가 동작하는 것을 볼 수 있습니다.

 

 

이처럼 개발 초기에 미리 설계된 API명세서를 기반으로 Mock Server를 설정해 놓게 되면 

실제 API서버에서 요청과 응답을 처리하는 것처럼 시물레이션 하여

프론트엔드와 백엔드 양 쪽 모두 지체 없이 바로 개발을 시작할 수 있다는 큰 장점이 있습니다.