Resteasy - générer RESTE de la documentation de Javadoc et les Annotations
Je voudrais trouver un moyen de générer de nice RESTE la documentation de l'API de java code (WADL ou HTML) - basé sur JAXB, JAX-RS annotations et java doc commentaires (pas de doclet s'il vous plaît).
Voici mon projet environnement
- Printemps, pas de XML seules les annotations
- Reste-facile de REPOS fournisseur de
- JAXB et JAX-RS annotations
- Type Mime pour le repos de l'API JSON
OriginalL'auteur Maciej Miklas | 2012-01-03
Vous devez vous connecter pour publier un commentaire.
Essayer Énoncer.
Peut être trouvé à l'adresse github.com/stoicflame/enunciate
OriginalL'auteur Marek
Comme une alternative à
Enunciate
, vous pourriez aussi envisagerMireDot
. Il a grandi à partir d'un outil que nous utilisons au sein de notre propre entreprise et il est gratuit pour les projets open source. C'est exactement ce que vous décrivez: il combine jaxrs annotations existantes et commentaires javadoc pour générer une api rest. Il fonctionne comme un plugin maven pour laquelle vous avez juste à ajouter à votre projet. Jaxb les annotations ne sont pas encore pris en charge au moment de l'écriture, mais l'outil est en développement actif, et nous choisir les fonctionnalités à mettre en œuvre sur la base de propositions/demandes/feedback.J'ai utilisé MireDot avec RestEasy et il est vraiment cool et facile à configurer
Le seul "problème" avec MireDot est la clé de licence. Un par artifactId... (même pour la partie libre)
OriginalL'auteur Yves V.
Le Compilateur Java Api vous permettent d'écrire du code qui analyse les sources Java et effectuer votre propre traitement.
Voici un didactique de l'article, qui comprend de l'information sur le traitement des annotations.
Je suppose que vous pouvez extraire les premières informations dont vous avez besoin en utilisant ces Api. Cependant, cela va de rendement syntaxique faits - le RESTE des Url, des mesures et des paramètres, l'utilisateur peut également bénéficier d'un complément d'explication, l'auteur du service pourrait (devrait?) fournir en Java Doc.
la pleine solution pourrait être d'analyser à la fois l'annotation et la java doc et de combiner les deux.
Je suppose que je suis en supposant qu'un plugin n'existe pas encore, et en suggérant comment on pouvait être écrite. Ma recommandation serait juste pour l'utilisation de JavaDoc.
OriginalL'auteur djna