Génération de la documentation HTML à partir de WSDL

Quels sont vos approches pour générer une sorte de lisible par l'homme, de la documentation à partir de fichiers wsdl?
Dans le passé, j'ai utilisé WSDL spectateur (par Tomi Vanek) et je suis heureux avec les résultats, mais je suis intéressé par toutes les alternatives possibles.

J'ai aussi entendu parler de x3sp, mais je n'ai pas essayé.

InformationsquelleAutor Igor Brejc | 2009-03-26
  1. 20

    J'ai essayé plusieurs solutions de rechange

    et a fini à peaufiner WSDL spectateur à mes besoins.

    • La version actuelle de TechWriter for Web Services prend également en charge une seule page HTML.
    • Même chose ici. je suis allé wsdl spectateur. soapui pro l'utilise trop haha
    • TechWriter était à la retraite... certains peuvent partager un numéro de licence?
    • Je pense que le lien pour techwriter est obsolète. C'est probablement la nouvelle. techwriter.- moi
    InformationsquelleAutor fglez
  2. 8

    Utilisation http://code.google.com/p/wsdl-viewer/ et cygwin est xsltproc

    xsltproc wsdl-viewer.xsl downloaded-wsdl.xml > documetnation.html

    Fonctionne comme un charme

    • cela ressemblait à des produits différents au premier abord, mais je peux le voir, c'EST la même chose maintenant :))
    • fonctionnait très bien, mais ne pas aller trop profondément dans le XSD si l'on accompagne les fichiers de l'extérieur. j'ai eu à utiliser ce + Schéma observateur
    InformationsquelleAutor Tomáš Fejfar
  3. 8

    Oui, il y a un nouveau: wsdl2html. Il se concentre sur demande/réponse et supprime les infos que les gens ne s'en soucient pas.

    • J'ai essayé en utilisant cela, mais je n'ai pas une liste complète de services. Un seul de mes 27 services a été affichée
    • J'aime wsdl2html est de la simplicité, ce qui le rend très pratique pour communiquer l'information essentielle à propos d'un service sans confondre le public. À mon avis, la seule caractéristique importante qui manque, c'est l'obtention de description/observations pour les opérations et les éléments.
    • salut, j'ai mis à jour le lien. Maintenant, il est hébergé sur github.
    InformationsquelleAutor Jian Chen
  4. 7

    Il n'est pas listée ici, mais SoapUI a un utile wsdl générateur de documentation.

    Clic-droit sur votre projet et sélectionnez "Générer de la Documentation".

    • Semble utiliser le plus tôt mentionné wsdl-viewer.xsl (qui a déménagé à Apache Woden), le résultat semble le même.
    • A très bien fonctionné. Déjà eu un projet créé dans SOAPUI, et il a créé une belle page html pour moi.
    InformationsquelleAutor Halfstop
  5. 5

    Maintenant, il est un outil de plus pour celle-ci, appelée "DocFlex/XML WSDLDoc".

    C'est une nouvelle WSDL/XSD générateur de documentation qui vous permettra de document de n'importe quel nombre de fois WSDL et XML schema (XSD) des fichiers de plus tous les interconnexions entre eux.

    Il ya aussi une option pour l'inclusion automatique de schémas XSD générés par Altova XMLSpy ou de l'Oxygène XML. Effectivement, l'un d'eux peut être utilisé comme liée de façon dynamique de création de diagrammes moteur.

    PRINCIPALES CARACTÉRISTIQUES

    • Génération d'une seule encadrée (Javadoc) et documentation HTML par un certain nombre de WSDL/XSD fichiers ensemble. (Si vous avez trop de fichiers d'entrée, vous pouvez choisir à l'aide d'une Fourmi-comme le chemin le motif).
    • Le traitement d'un certain nombre de schémas XML (avec WSDL), y compris:
      • Sous forme de fichiers XSD
      • Schémas XML intégré dans WSDL (dans <wsdl:definitons>/<wsdl:types> élément)
    • La transformation de la référencé fichiers WSDL et XML schémas, en particulier:
      • Le traitement Correct de toutes les <wsdl:import>, <xs:import>, <xs:include>, <xs:redefine> éléments que l'on retrouve à travers toutes les parties impliquées WSDL/XSD fichiers.
      • Automatique de chargement et de traitement (à savoir l'inclusion dans la documentation de la portée), et ce, directement/indirectement référencé WSDL/XSD fichiers.
    • Sophistiquée de la documentation des XSD composants (schéma XML de la documentation):
      • Soutien d'aucun schéma XML des modèles de conception.
      • Possibilité d'inclusion automatique de schémas XSD générés par XMLSpy ou Oxygen XML, avec le soutien de tous les diagramme des liens hypertexte.
    • Documentation de tous les interconnexions entre WSDL définitions et XSD composants:
      • Des liens hypertexte à partir de WSDL messages pour les détails des éléments XSD/types décrivant les données du message.
      • Dans l'élément XSD/détails concernant le type, la liste de tous les WSDL définitions où ils sont utilisés.
      • Copier les annotations des éléments XSD/types pour la documentation de ces messages WSDL (et même des opérations), où ils sont utilisés.
    • Possibilité illimitée personnalisation. WSDLDoc est en fait un ensemble de modèles pour DocFlex/XML, un système de logiciels pour le développement et l'exécution de haute performance de la documentation et des générateurs de rapports à partir de données stockées dans des fichiers XML.

    EXEMPLE

    Voici une démo de ce type de documentation (il a été généré par un seul fichier source:
    http://developer.ebay.com/webservices/latest/ebaySvc.wsdl):

    Génération de la documentation HTML à partir de WSDL

    Le HTML lui-même: http://www.filigris.com/docflex-xml/wsdldoc/examples/html/ebaySvc/index.html

    LIENS

    http://www.filigris.com/docflex-xml/wsdldoc/

    • J'ai utilisé le document XML produit depuis un certain temps et j'ai été absolument ravie par la qualité du produit.... dommage que mon entreprise n'ont pas le budget pour acheter des licences, mais j'ai été heureux d'en acheter un pour moi-même...
    • Il semble que produit commercial, licence nécessaire pour la fonctionnalité complète
    InformationsquelleAutor Leonid Rudy
  6. 3

    Je viens de découvrir que Notepad++ avec des Outils Xml installé le plugin peut aussi faire des transformations xsl. Si vous fournir le wsdl-viewer.xsl mentionné plus tôt, et le fichier wsdl, vous aurez une bien formaté en html comme un résultat.

    • Si vous utilisez Eclipse avec EE, il vous permet de traiter un fichier XSLT simplement en cliquant-droit dessus et en sélectionnant Exécuter.
    InformationsquelleAutor Patrick Koorevaar
  7. 2

    Altova est XMLSpy ne génère la documentation HTML à partir d'un WSDL
    ... mais ce n'est pas gratuit 😉

    InformationsquelleAutor Alexandre Victoor
  8. 1

    Je sais que ce pauvre homme à la documentation de la méthode, mais j'ai utilisé de l'ouverture du fichier wsdl du XSD dans visual studio et de faire snag-elle imprime avec des commentaires et des flèches ajouté pour plus de clarté et de nos client semble avoir aimé sans avoir à utiliser un autre outil. Vous aussi, n'ont pas cette mais pourrait utiliser une version de gratuit VPC ou abonnement MSDN j'ai aussi utilisé le BizTalk éditeur de schéma pour afficher le XSD et ainsi de document à partir de là à l'aide de snag-it ou une autre application de capture d'écran. Je vais essayer, et utilisez ce que vous avez!

    -Bryan

    InformationsquelleAutor Bryan Corazza
  9. 0

    Vous pouvez utiliser "wsimport", qui fait partie du JDK et exécuter Javadoc sur les fichiers générés. En supposant que vous avez mis dans les annotations, il les mettra dans le cadre de la documentation.

    Un autre outil serait Rational Application Developer qui permet de faire un clic droit et de générer la documentation HTML, avec de jolies hyperliens de photos.

    InformationsquelleAutor Archimedes Trajano
  10. 0

    Vous pouvez utiliser iDocIt! document WSDL et d'exporter ensuite la documentation au format HTML. C'est un open source Eclipse plugin téléchargeable ici.

    Il offre une nouvelle approche de la création de documentations thématiques grilles thématiques et des rôles, mais vous avez besoin de ne pas les utiliser. Vous pouvez créer des documentations encore sous forme de texte brut.

    InformationsquelleAutor Dirk