RESTdoc

RESTdoc ist ein Tool zum Erzeugen von Dokumentationen für REST-Services. Es nutzt dabei keinerlei eigene Tags in Kommentaren oder eigene Annotationen, sondern verlässt sich vielmehr auf sowieso vorhandene, normale Javadoc-Kommentare. Somit entsteht für den Entwickler kein Mehraufwand beim Programmieren.

Die Nutzung von RESTdoc ist denkbar einfach. Intern verwendet RESTdoc ein Meta-Modell und bietet Report-Klassen, die vorhandenen Code, in das Modell überführen. Dieses Modell kann dann selbst weiter verarbeitet werden oder über einen Printer-Mechanismus in verschiedene Formate ausgegeben werden, bspw. als HTML-Dokumentation. Es kann auch ein Maven-Report-Mojo verwendet werden, damit die Dokumentation immer selbsttätig beim Maven-Build erstellt wird.