herramienta similar a javadoc para spring-mvc rest api documentation?

Question

Estaba buscando una herramienta de documentación de la API REST tipo javadoc. Ya documenté mis controladores de reposo en javadoc y creo que sería bueno crear una API de los desarrolladores front-end.

Creo que todavía no hay una herramienta. Entonces, ¿alguien tiene ideas de cómo lograr esta tarea? Pensé en usar la herramienta clásica de javadoc y agregar un poco de spring/rest specific logic. Pero aún no estoy seguro de si también necesito un margen de beneficio especial o lo que podrían ser riesgos. Al final me gustaría tener alguna herramienta que pueda ser integrada en el ciclo de vida del sitio de maven, pero eso no debería ser difícil de lograr.

Puede ser difícil manejar la herencia: la uso mucho en los recursos de REST, pero para el lector, la herencia no es nada que le interese. Por lo tanto, los subcontroladores deben de alguna manera integrar los métodos de los supercontroladores, pero también ser capaces de crear alguna documentación significativa en el contexto del controlador real. No estoy seguro de si la primavera me permite sobrescribir los métodos de los supercontroladores, pero todavía evalúa sus anotaciones.

Agradecería cualquier sugerencia sobre proyectos relacionados, herramientas que ya existan o solo su experiencia con la herramienta javadoc.

Answer 1

Si desea hacerlo usted mismo, usted podría acercarse a él de esta manera:

1. Crear una implementación AnnotationReader que escanea para los diversos @Path anotaciones
2. prueba de que es capaz de leer el atributo
name
3. Cree un Maven mojo que envuelva esta funcionalidad de escaneo
4. Agregue la facilidad para mapear los parámetros de expresiones regulares (ej. {customerId}) en algo significativo para fines de documentación, tal vez leyendo el Javadoc asociado.

El lector de anotaciones no tendrá que hacer ninguna modificación en las anotaciones existentes, por lo que debería ser fácil crear una lista de las expresiones regulares de punto final. En combinación con los Javadocs, debería poder crear una herramienta útil. Ciertamente lo encontraría útil, y tal vez otros también lo harían.

Answer 2

Sé Enunciate, que funciona bastante bien con Jersey/CXF, pero no sé si lo hace con SpringMVC.

Answer 3

Debería ver RESTdoclet. http://ig-group.github.com/RESTdoclet/