API 문서화. API Documentation Generator 관련
# Compare API Documentation Generator
1. 고려할 사항
1) RESTful API를 문서화하기 편해야 한다.
2) 문서를 위한 파일을 따로 만들 필요가 없어야 한다.
3) 주석으로 작성한 내용을 문서로 만들어주는 형태이어야 한다.
4) Parameter가 보기 편해야 한다.
5) Example을 작성할 수 있어야 한다.
6) npm module 형태로 설치 가능해야 한다.
7) 학습 비용이 적어야 한다.
2. 후보군
1) JSDoc
- RESTful API 문서화하기 불편
2) Swagger
- 문서를 위한 파일을 따로 만들어야 함
- 작성하는 스타일 학습 필요
- 작성해야 할 내용 많음
3) API Blueprint
- 별도의 md 파일 작성해야 함
4) apiDoc
- 독자적인 문법 체계 쓰므로 학습 필요
- Parameter 보기 편함
5) groc
- 기존 JSDoc 스타일 그대로 사용 가능
- Parameter 알아보기 불편함
댓글
댓글 쓰기