[postman] api 문서 만들기

이번에 api 문서화를 하면서 경험했던 것을 보이기 위해서 작성합니다!

 

기존에 collection이 있던 상황!

컬렉션이 있는 모습

 

위에서 보이는 New 버튼을 눌러줍니다.

다른 블로그들을 찾아보면 postman 버전이 달라서 그런지 모르겠지만,

 

아래와 같이 docuemtn를 누르고 2번째 사진처럼 사진처럼 뜬다고 되어 있는데 현재는 조금 바뀌었습니다

document

기존 postman

 

제가 진행한것은 new를 누르고 API 아이콘 버튼을 눌렀습니다

현재 postman 부분

 

위의 사진에서 API를 누르면 아래와 같이 New API가 생성됩니다.

APi 생성

 

이러고 전체화면을 보시면, github repository를 연결하실지 마실지에 대한 문구를 볼 수 있습니다.

연결하지 않고도 만들어 볼 수 있으니, without repository를 눌러서 넘어 가면, 아래와 같은 화면이 뜹니다

 

collection 연결

이제 Collections를 눌러서 기존에 가지고 있던 collection을 연결해 줍니다.

 

그후에 우리가 보고 싶은 API 문서를 보고 싶다면,

 

해당 collection을 누른뒤, 맨 오른쪽 점 3개를 눌러서 View documentation을 선택하면 우리가 원하는 화면을 볼 수 있습니다.

 

이 화면 내에서 document 작성을 할때 mark up 기능을 지원하니 잘 사용해보자