[PostMan] API문서화하기

누구세요·2024년 10월 17일

설계 문서에 한땀한땀 API를 적고 있었는데 조장님이 자동으로 생성해주는걸 알려주셨다.

PostMan 실행 -> 상단에서 Workspaces선택 -> CreateWorkspace 선택하여 새로운 Workspace를 만든다.
기본으로 제공되는 My Workspace로는 문서화할 수 없다.

새로운 WorkSpace에 테스트할 API를 추가한다.

이미 My Workspace에 작성했을 경우 우클릭 -> Export해서 json파일로 저장한다음 새로운 Workspace에 드래그해서 넣으면 된다.

우클릭 -> View documentation클릭

미리보기가 나온다 여기서 우측 상단Publish클릭 처음 클릭시 회색이다.

그러면 웹 브라우저가 띄워진다. 여기서 추가로 설명할 것이 있으면 추가하고 아까와 마찬가지로 우측 상단의Publish을 클릭한다.

여기서 몇가지 옵션을 입맛대로 선택하고 아래로 내려가서 Publish버튼을 클릭하면

이렇게 링크가 생성된다.

0개의 댓글