web-dev-qa-db-fra.com

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

Quelles sont vos approches pour générer une sorte de documentation lisible par l'homme à partir de WSDL? Dans le passé, j'ai utilisé WSDL Viewer (de Tomi Vanek) (voir mon article de blog sur son intégration dans NAnt ) et je suis satisfait du résultat, mais je suis intéressé par tout résultat possible. des alternatives.

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

web-servicesdocumentationwsdlnant
49
Igor Brejc

J'ai essayé plusieurs alternatives

et a fini par peaufiner le visualiseur WSDL selon mes besoins.

19
fglez

Utilisez http://code.google.com/p/wsdl-viewer/ et le xsltproc de cygwin

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

Fonctionne comme un charme

8
Tomáš Fejfar

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

8
Jian Chen

Il n'est pas répertorié ici, mais SoapUI dispose d'un générateur de documentation wsdl utile.

Faites un clic droit sur votre projet et sélectionnez "Générer la documentation".

6
Halfstop

Maintenant, il existe un autre outil pour cela, appelé " DocFlex/XML WSDLDoc ". 

Il s'agit d'un nouveau générateur de documentation WSDL/XSD qui vous permettra de documenter un nombre illimité de fichiers de schéma WSDL et XML (XSD), ainsi que leurs éventuelles interconnexions.

Il existe également une option pour l'inclusion automatique des diagrammes XSD générés par Altova XMLSpy ou Oxygen XML. Chacun d'entre eux peut effectivement être utilisé comme moteur de création de diagrammes lié dynamiquement.

PRINCIPALES CARACTÉRISTIQUES

  • Génération de la documentation HTML unique (de type Javadoc) par un nombre quelconque de fichiers WSDL/XSD ensemble. (Si vous avez trop de fichiers en entrée, vous pouvez tous les sélectionner en utilisant un modèle de chemin d'accès de type Ant).
  • Traitement d'un nombre quelconque de schémas XML (avec WSDL), notamment:
    • Sous forme de fichiers XSD séparés
    • Schémas XML incorporés dans WSDL (dans l'élément <wsdl:definitons>/<wsdl:types>)
  • Traitement de fichiers WSDL et de schémas XML référencés, notamment:
    • Traitement correct de tous les éléments <wsdl:import>, <xs:import>, <xs:include>, <xs:redefine> trouvés dans tous les fichiers WSDL/XSD impliqués.
    • Le chargement et le traitement automatiques (c’est-à-dire inclus dans la portée de la documentation) concernent tous les fichiers WSDL/XSD référencés directement ou indirectement.
  • Documentation sophistiquée des composants XSD (documentation du schéma XML):
    • Prise en charge de tout modèle de conception de schéma XML.
    • Possibilité d'inclusion automatique des XSD diagrammes générés par XMLSpy ou Oxygen XML , avec la prise en charge de tous les liens hypertexte des diagrammes.
  • Documentation de toutes les interconnexions entre les définitions WSDL et les composants XSD:
    • Hyperliens des messages WSDL vers les détails des éléments/types XSD décrivant les données du message.
    • Dans les détails d'élément/type XSD, la liste de toutes les définitions WSDL où elles sont utilisées.
    • Copiez les annotations des éléments/types XSD dans la documentation de ces messages WSDL (et même des opérations) où ils sont utilisés.
  • Possibilité de personnalisation illimitée. WSDLDoc est en fait un ensemble de modèles pour DocFlex/XML , un système logiciel permettant de développer et d'exécuter une documentation haute performance et des générateurs de rapports à partir de toutes les données stockées dans des fichiers XML.

EXEMPLE

Voici une démonstration de cette documentation (elle a été générée par un seul fichier source: http://developer.ebay.com/webservices/latest/ebaySvc.wsdl ):

eBay Trading API - WSDL documentation

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

LIENS

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

5
Leonid Rudy

Je viens de découvrir que Notepad ++ avec le plugin Xml Tools installé peut également effectuer des transformations xsl. Si vous lui fournissez le fichier wsdl-viewer.xsl mentionné précédemment et le fichier wsdl, vous obtiendrez un code HTML bien formaté.

2
Patrick Koorevaar

XMLSpy d’Altova génère une documentation HTML à partir d’un WSDL ... mais ce n’est pas gratuit;)

2
Alexandre Victoor

Je connais cette méthode de documentation pour un homme pauvre, mais j’ai utilisé l’ouverture du fichier XSD de wsdl dans Visual Studio et l’impression précise avec des commentaires et des flèches pour plus de clarté et notre client semble l’avoir aimé sans avoir à utiliser un autre outil . Vous pouvez également ne pas l'avoir, mais utiliser une version d'un abonnement VPC ou MSDN gratuit. J'ai également utilisé l'éditeur de schéma BizTalk pour afficher également le fichier XSD et le documenter à partir de là à l'aide de snag-it ou d'une autre application de capture d'écran. Je voudrais essayer d'utiliser ce que vous avez!

-Bryan

1
Bryan Corazza

Vous pouvez utiliser "wsimport", qui fait partie du JDK, et exécuter Javadoc sur les fichiers générés. En supposant que vous ayez mis les annotations, elles seront intégrées à la documentation.

Rational Application Developer est un autre outil qui vous permet de cliquer avec le bouton droit de la souris et de générer la documentation HTML avec de jolies images en hyperlien.

0
Archimedes Trajano

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

Il fournit une nouvelle approche de création de documentations avec des grilles thématiques et des rôles thématiques, mais vous ne devez pas les utiliser. Vous pouvez créer des documentations toujours en texte brut.

0
Dirk