Dev Faq
7
votes

Resease - Générez une documentation de repos à partir de Javadoc et d'Annotations

J'aimerais trouver un moyen de générer une documentation d'API de repos de java (WADL ou HTML) - basée sur JAXB, JAX-RS ANNOTATIONS ET JAVA DOC Commentaires (aucun DOCLET s'il vous plaît).

Voici mon environnement de projet

  • printemps, pas d'annotations XML uniquement
  • Rest-easy comme fournisseur de repos
  • Jaxb et Jax-Rs Annotations
  • Type MIME pour API de repos à JSON
0 commentaires

3 Réponses :

1
votes

Les API de compilateur Java vous permettent d'écrire du code qui analyse Java Source et effectuez votre propre traitement.

Voici un article d'instruction , qui inclut des informations sur les annotations d'analyse.

Je suppose que vous pouvez extraire les informations brutes dont vous avez besoin en utilisant ces API. Cependant, cela va donner des faits syntaxiques - les URL et les actions et paramètres de repos, un utilisateur bénéficierait également d'une explication supplémentaire, que l'auteur de service pourrait (devrait?) Fournir à Java Doc.

La solution complète pourrait être d'analyser à la fois Annotation et Java Doc et combiner les deux.

2 commentaires

Droite .... Mais j'aimerais avoir plus comme un plugin maven qui gérerait cela pour moi - et seule la génération de DOC, aucun client libérant ou quelque chose comme ça.

Je suppose que je suppose qu'un plugin n'existe pas encore et suggère comment on pourrait être écrit. Ma recommandation serait juste d'utiliser Javadoc.

14
votes

Essayez Encomment .

Enccia est un moteur destiné à améliorer considérablement votre API de service Web Java. C'est simple. Vous développez votre API de service Web à l'aide de Technologies Java standard et joignez-la énoncer à votre processus de construction. Soudainement, votre service Web API offre des caractéristiques assez impressionnantes:

  • Documentation HTML complète de vos services, grattées de votre Javadocs.
  • Bibliothèques côté client (par exemple Java, .NET, iPhone, Ruby, Flex, Ajax, GWT, etc.) Pour les développeurs qui souhaitent interfacer avec votre API.
  • Documents de définition d'interface (par exemple WSDL, WADL, XML-SCHEMA, etc.)
  • etc.
2 commentaires

Impossible de le trouver sur le Web. N'importe qui?

Peut être trouvé à GITUB.COM/STOICFLAME/NONNONCIATE

10
votes

comme alternative à énonciquer , vous pouvez également envisager miredot < / a>. Il a grandi à partir d'un outil que nous utilisons au sein de notre propre entreprise et il est libre d'utiliser des projets open source. Il fait exactement ce que vous décrivez: il combine les annotations JAXRS et les commentaires javadoc existants pour générer une API de repos. Cela fonctionne comme un plug-in Maven que vous devez simplement ajouter à votre projet. Les annotations JAXB ne sont pas encore soutenues au moment de la rédaction, mais l'outil est en cours de développement actif et que nous choisissons les fonctionnalités à mettre en œuvre en fonction de suggestions / demandes / commentaires.

3 commentaires

Essayé miredot juste maintenant, et c'est vraiment bien!

J'ai utilisé miredot avec repose et est vraiment cool et facile à configurer

Le seul "problème" avec miredot est la clé de licence requise. Un par artefactid ... (même pour la partie libre)

Articles qui pourrait vous intéresser :

 Comment envoyer une liste vide à la clause IN
Code de réponse 403 inattendu lors de la récupération des données des API
Impossible de trouver la classe UnityPlayerActivity dans com.unity3d.player
Comment définir un tableau dans jsonobject