- 내가 작성한 api 문서와 예시를 다른 팀원들과 손쉽게 공유하는 방법을 찾다가 postman의 문서화 기능을 이용하는 방법과, team workspace로 팀원들이 함께 편집할 수 있는 워크스페이스를 만드는 법을 알게 되었다.
- postman 상단에서 workspaces - create workspace로 들어간다.
- 워크스페이스 이름, 소개, 접근 권한을 설정하고 create workspace 를 누른다. 그러면 빈workspace 가 만들어진다.
- 워크스페이스 홈 상단에서 workspace settings를 눌러 setting에 들어간다.
- invite를 누르면 다음과 같은 창이 나온다.
- 좌측 하단의 copy invite link를 누르고, 복사한 링크를 초대하고 싶은 팀원에게 보낸다. (무료 플랜은 최대 3명까지 가능하다)
- 각자 personal workspace에서 만든 api request를 move 해서 그대로 이곳에 추가할 수 있으며, 해당 페이지의 request documentation도 함께 볼 수 있어 위와 같이 team workspace를 간단하게 만들 수 있다.
이렇게 팀 워크스페이스에 작업 내용을 공유하면 본인이 만든 api가 아니더라도 쉽게 request와 response 형식을 확인하고 테스트할 수 있어 협업에 큰 도움이 된다. 또한 문서화 한 api document는 frontend 측에도 공유하면, key-value의 형태를 쉽게 확인할 수 있어 통신시 key 오류로 일어나는 문제를 줄일 수 있을 것으로 기대된다.
