2011-02-12 9 views
19

Estoy desarrollando un servicio web con CXF mediante el uso de anotaciones JAX-RS en recursos. Estas anotaciones especifican nombres de argumentos, valores predeterminados y los tipos válidos de mime de entrada y salida.¿Existen herramientas tipo javadoc para generar apdoc de servicio web RESTful a partir de anotaciones JAX-RS?

Sería bueno poder ejecutar una herramienta javadoc-esque en mi código para generar un conjunto conciso de documentación de esta interfaz, pero parece que no puedo encontrar nada.

Los documentos producidos por javadoc requerirían demasiado recorte, realmente quiero algo que entienda la semántica de las anotaciones JAX-RS y genere algo amigable para los desarrolladores que quieran usar mi servicio.

Respuesta

6

Si está creando servicios web tranquilos, la documentación se conoce como WADL. WADL es básicamente la versión de Rest de WSDL. Yo uso Jersey para construir mis servicios web Restful. Jersey crea automáticamente el WADL basado en las anotaciones que tiene en su paquete de recursos. Así es como se ve la muestra WADL desde el sitio web de Jersey: https://java.net/projects/jersey/sources/svn/show/trunk/jersey/samples/generate-wadl

La mejor parte de esto es que no hace absolutamente nada. :) Cuando cambie la anotación URI o parámetros en sus clases Resource, se reflejarán automáticamente en esta documentación.

TADAA! :)

+0

Gracias por los enlaces. No había oído hablar de WADL, así que eso ayudó, pero realmente estaba buscando algo legible para los humanos. Existen hojas de estilo XSLT para transformar WADL en HTML, como https://github.com/mnot/wadl_stylesheets –

+1

¿Cómo le dice a Jersey que @GET (/ foo) significa "recuperar la barra de objetos comerciales" y @QueryParam (nombre = "bla") significa "Proporcionar fecha de inicio en milisegundos"? –

14

Eche un vistazo a Enunciate. Hay un Maven plugin que generará documentos incluidos en el sitio.

+0

¡Agradable! Integración Maven - Estoy en. –

+0

Bueno, excepto que no admite múltiples argumentos @FormDataParam. – Pepster

Cuestiones relacionadas