API 문서작성(명세서)에 관한 비교 (Swagger vs Postman vs GitBook)

Swagger

 

 

• 무료로 제공됨
• 문서 자체에서 해당 API 테스트 가능
• But, API를 카테고리 별로 나누는 기능은 없음
  (모든 API가 한 페이지에 나타나서 원하는 API를 찾기 쉽지 않음)

 

 

 

Postman

 

 

• publish: 포스트맨 자체에서 바로 문서로 들어갈 수 있다. (따로 주석 작성 X)
  -> 유지 보수가 용이
• Swagger에 비해 원하는 API 찾기 수월함
• 실제 테스트한 API 기반으로 문서 작성을 해주어 간편함
• 해당 API에 대한 코멘트만 따로 추가해주면 되어 시간 단축

 

GitBook

 

• UI가 깔끔해 프로젝트 별로 관리가 용이
• 파라미터와 리스폰스까지 기록하고 보기 편해 API 이해 측면에서 장점이 있음
• 해당 테스트를 GitBook상에서 직접 해볼 수 없다는 단점이 있음