Resteasy - generieren REST der Dokumentation von Javadoc und Anmerkungen

Ich würde gerne einen Weg finden, zu generieren schönen REST-API-Dokumentation von java-code (WADL oder HTML), basierend auf JAXB, JAX-RS annotations und die java-doc-Kommentare (keine doclet bitte).

Hier ist mein Projekt-Umgebung

  • Frühling, nicht nur XML-Annotationen
  • Rest-einfach als REST-Anbieter
  • JAXB und JAX-RS-Annotationen
  • Mime-Typ für die rest API im JSON -
InformationsquelleAutor Maciej Miklas | 2012-01-03
  1. 14

    Versuchen Aussprechen.

    Behauptet ist ein Motor für dramatisch verbessern Sie Ihre Java-Web-service-API.
    Es ist ganz einfach. Sie entwickeln Web-service-API mit standard-Java-Technologien und befestigen Sie Behauptet, um Ihren build-Prozess. Plötzlich, Ihre Web-service-API ist mit einigen ziemlich beeindruckende features:

    • Vollständige HTML-Dokumentation Ihrer Leistungen, geschabt von Ihrem JavaDocs.
    • Client-seitige Bibliotheken (z.B. Java, .NET, iPhone, Ruby, Flex, AJAX, GWT, etc.) für Entwickler, die Benutzeroberfläche mit Ihren API.
    • Interface-Definition-Dokumente (z.B. WSDL, WADL, XML-Schema, etc).
    • Etc.
    InformationsquelleAutor Marek
  2. 10

    Als alternative zu Enunciate Sie könnten auch erwägen MireDot. Es wuchs von einem Werkzeug, das wir verwenden innerhalb unserer eigenen Gesellschaft, und es ist kostenlos für open-source-Projekte. Es tut genau das, was Sie beschreiben: es verbindet jaxrs Anmerkungen und bestehenden javadoc-Kommentare zu generieren, die eine rest-api. Es funktioniert wie ein maven-plugin, welches Sie gerade haben, zu Ihrem Projekt hinzufügen. Jaxb-Annotationen werden noch nicht unterstützt im moment des Schreibens, aber das tool ist in der aktiven Entwicklung und wir nehmen die Funktionen zu implementieren, basierend auf Anregungen/Wünsche/feedback.

    • Versucht MireDot gerade jetzt, und es ist WIRKLICH GUT!
    • Ich habe verwendet, MireDot mit RestEasy und ist wirklich cool und einfach zu konfigurieren
    • Das einzige "problem" mit MireDot ist der benötigte Lizenz-key. Eine pro artifactId... (auch für den kostenlosen Teil)
    InformationsquelleAutor Yves V.
  3. 1

    Den Java-Compiler-APIs ermöglichen es, code zu schreiben, analysiert Java-Quellcode und führen Sie Ihre eigenen Verarbeitung.

    Hier ist ein Lehr-Artikel, die enthält Informationen über das Parsen der Annotationen.

    Ich denke, das können Sie extrahieren Sie die raw-Informationen, die Sie benötigen Verwendung dieser APIs. Aber das wird die Ausbeute syntaktischen Fakten - der REST-URLs und Aktionen und Parameter, die von einem Benutzer profitieren auch von der zusätzlichen Erklärung, die den service Autor könnte (sollte?) in Java-Doc.

    den vollständigen Lösung sein könnte, um zu analysieren, sowohl Anmerkungen und java-doc und kombinieren die zwei.

    • richtig.... aber ich würde gerne mehr wie maven-plugin, das handhaben würde, dies für mich - und NUR doc generation, keine client-lib oder sowas.
    • Ich denke, ich gehe mal davon aus, dass bereits ein plugin existiert noch nicht, und vorschlagen, wie man geschrieben werden konnte. Meine Empfehlung wäre nur die Verwendung von JavaDoc.
    InformationsquelleAutor djna
Schreibe einen Kommentar