[포스트맨] api 문서화해서 웹 상에 공유하기.

기존 일처리 방식

1) api를 만든다.

2) api에 필요한 요소들을 문서화한다.

3) 구글 doc을 사용할 경우 기존 양식을 복사해서 새로운 문서에 붙여놓고 해당 부분을 수정한다.

4) api 테스트를 하는 사람은 3번 문서를 확인해서 url, 파라미터 등을 복사해서 테스트를 수행한다.

 

 

api 테스트 툴인 포스트맨에서 테스트 후 해당 내용을 자동으로 문서화해서 웹상에 출판할 수 있는 기능을 소개한다.

 

1. 왼쪽 상단 New > API Documentation 을 클릭한다.

 

 

 

 

 

 

2. method와 request url 과 description을 입력 후 오른쪽 하단에 Next버튼을 클릭한다.

 

 

 

 

 

 

 

 

 

왼쪽 사이드 바에 목록이 만들어지면 테스트 케이스를 작성해서 수행할 수 있다.