Postman Mock Server / API Documentation 만들기

holang-i·2021년 12월 2일
0
post-thumbnail
post-custom-banner

API 문서는 나왔지만, 서버쪽 코드가 작성이 안 되어 있는 경우를 대비하여 Postman을 사용해서 Mock Server와 API 문서를 만들어 보려고합니다.


Mock Server 생성하기

  1. postman을 실행하면 아래와 같은 프로그램이 뜨고 새로운 프로젝트에 대한 Mock Server를 만들기위해 화면 왼쪽에 보이는 New 버튼을 클릭한다.

아래와 같은 창이 뜨는데 Mock Server 부분을 클릭한다.

  1. 아래와 같은 화면이 나오는데 Request Path 부분을 작성해야만 Next 버튼이 활성화 되기 때문에 Request Path부분을 작성 해 볼 것이다.

  2. GET / 요청이 들어왔을 때 메인 페이지를 보여줄 것인데 우선 path만 입력해 둘 것이다. (나중에 수정할 예정)

  3. Name을 입력하지 않으면 Next 버튼이 활성화 되지 않기 때문에 프로젝트 이름에 맞춰서 mock server의 이름을 지정해 줄 것이다. (Name은 원하는 대로 지정하면 된다.)

  4. Name을 지정하면 화면 하단의 버튼이 Create Mock Server로 변경된 것을 확인할 수 있다.
    Environment 부분은 이미 존재하는 Collection에 Mock Server를 추가하는 것이라면 해당 Collection의 이름을 선택해주면 되지만, Collection이 지금은 없기 때문에 No Environment인 상태로 두고 진행 하면 된다.

  1. 그러면 아래와 같이 Mock Server URL이 발급된다.

  2. 주어진 URL주소로 요청을 날려서 200 응답이 잘 날라오는 것을 확인할 수 있다.

  3. 그리고 Collections에 Mock Server를 만들었더니 Collections에 추가 된 것을 확인할 수 있다.

post-custom-banner

0개의 댓글