JavaDoc 스타일의 REST API 도큐멘테이션 툴이 있나요?

[Geun-Woo, Shin]

안녕하세요. 조용히 구경만 하다가 큰맘먹고 질문 포스팅을 하나 해 봅니다.

Spring Web MVC 기반으로 REST API 들을 만들고 있습니다.

API 내역을 위키를 이용해서 도큐먼트를 정리하고 있는데요,

변경이 있을때마다 코드 고치고 주석 고치고 위키 고치고 하는게 일이다 보니 이걸 자동화해주는 툴을 찾고 있습니다.

일단 비슷한 걸 찾은건 Enunciate 가 있는데요,

얘는 얼핏 보니 org.springframework.web.bind.annotation.* 가 아니라 javax.ws.rs.* 를 읽는듯하더군요.

혹시, 이런식으로 Spring Web MVC의 Annotation 및 JavaDoc 를 읽어서 REST API 도큐먼트를 생성해주는 툴이 있을까요?

[Sungchul Park]

특정 커스텀 태그를 정해서 javadoc을 작성하고 Javadoc의 Doclet API를 사용해 이 커스텀 태그와 스프링 어노테이션을 분석하는 문서 생성기를 만들면 어렵지 않게 기본적인 Rest API 문서를 만들어낼 수 있을 겁니다.
하지만 스프링이 지원하는 다양한 URL 매핑/바인딩 전략과 확장 기능까지 고려해서 문서를 생성해내는 문서 생성기를 만들 수 있을지 의문이네요.
API 수가 많지 않으면 그냥 따로 문서화하는 방법에 비해 별 이득이 없을 것 같습니다. 오히려 소스 코드만 복잡하게 만들지 않을까 싶네요.

12. 5. 22. 오후 12:10, Geun-Woo, Shin 쓴 글:

--
Google 그룹스 'Korea Spring User Group' 그룹에 가입했으므로 본 메일이 전송되었습니다.
이 그룹에 게시하려면 ks...@googlegroups.com(으)로 이메일을 보내세요.
그룹에서 탈퇴하려면 ksug+uns...@googlegroups.com로 이메일을 보내주세요.
더 많은 옵션을 보려면 http://groups.google.com/group/ksug?hl=ko에서 그룹을 방문하세요.