Con la creciente popularidad de REST y más recientemente del concepto API se hace muy importante disponer de herramientas que nos permitan documentar de forma sencilla nuestra APIs REST.
Afortunadamente en el mundo Java/JEE/Spring disponemos de varias opciones.
Desde las más sencillas como:
SpringDoclet que es un doclet de Javadoc que genera documentación de artefactos Spring. Aunque es de ámbito genérico Spring también genera documentación de los Servicios REST Spring:
Que permite generar documentación HTML de nuestros Servicios REST de forma automática a partir del código fuente lo que nos permite actualizar la documentación de forma continua.
Ofrece out-of-the-box soporte para Servicios RESTful Spring 3 a través de Javadoc.
Ofrece integración con Maven para automatizar la generación.
A los más potentes como:
Swagger (del que ya hablamos en este post) que es un framework complete para describer, consumer y visualizer Servicios RESTful.
Permite de forma automática
generar documentación HTML+JS:
invocación desde JS,
Descripción del interfaz del API en JSON:
Y todo esto simplemente anotando nuestro Servicio REST de esta forma:
I/O Docs que es una herramienta creada por Mashery similar a Swagger en cuanto a la parte de generación de documentación:
Otras soluciones como
o
ofrecen esta funcionalidad en formato Servicio permitiendo
Documentar,
buscar
e invocar APIs desde su Web











Deja un comentario