Générer une documentation HTML à partir de WSDL

Question

Quelles sont vos approches pour générer une sorte de documentation lisible par l'homme à partir des WSDL ? Dans le passé, j'ai utilisé Visualiseur WSDL (par Tomi Vanek) et je suis satisfait des résultats, mais je suis intéressé par toute alternative possible.

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

Answer 1

J'ai essayé plusieurs alternatives

• TechWriter pour les services Web : Vraiment puissant, mais la sortie HTML était (voir commentaires) multi-fichier. De plus, les commentaires indiquent qu'il a été retiré, mais ce n'est plus le cas.
• <oXygen/> Éditeur XML : Il ne traite pas les schémas embarqués.
• Altova XML Spy : Il ne traite pas les types anonymes.

et j'ai fini par adapter le visualiseur WSDL à mes besoins.

Answer 2

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

Answer 3

Utilice 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

Answer 4

Il existe désormais un outil supplémentaire 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 WSDL et de schémas XML (XSD), ainsi que toutes les interconnexions entre eux.

Il existe également une option pour l'inclusion automatique des diagrammes XSD générés par Altova XMLSpy ou Oxygen XML. En fait, n'importe lequel de ces outils peut être utilisé comme moteur de création de diagrammes liés dynamiquement.

CARACTÉRISTIQUES PRINCIPALES

• Génération de cadres uniques (à la manière de Javadoc) Documentation HTML par un nombre quelconque de Fichiers WSDL/XSD ensemble. (Si vous avez trop de fichiers d'entrée, vous pouvez les sélectionner tous en utilisant un modèle de chemin d'accès de type Ant).
• Traitement d'un nombre quelconque de Schémas XML (avec WSDL), y compris :
  • Sous la forme de fichiers XSD distincts
  • Les schémas XML intégrés dans WSDL (au sein de <wsdl:definitons>/<wsdl:types> élément)
• Traitement de tout référencé Les fichiers WSDL et les schémas XML, en particulier :
  • Traitement correct de tous les <wsdl:import> , <xs:import> , <xs:include> , <xs:redefine> que l'on retrouve dans tous les fichiers WSDL/XSD concernés.
  • Chargement et traitement automatiques (c'est-à-dire inclusion dans la portée de la documentation) de tous les fichiers WSDL/XSD directement/indirectement référencés.
• Documentation sophistiquée de Composants XSD (documentation du schéma XML) :
  • Prise en charge de tout modèle de conception de schéma XML.
  • Possibilité d'inclusion automatique de Diagrammes XSD généré soit par XMLSpy o Oxygène XML avec le soutien de tous les hyperliens du diagramme.
• Documentation de tous les interconnexions entre les définitions WSDL et les composants XSD :
  • Hyperliens depuis les messages WSDL vers les détails des éléments/types XSD décrivant les données du message.
  • Dans les détails des éléments/types XSD, la liste de toutes les définitions WSDL où ils sont utilisés.
  • Copier les annotations des éléments/types XSD dans la documentation des messages WSDL (et même des opérations) où ils sont utilisés.
• Possibilité d'illimité personnalisation . WSDLDoc est en fait un ensemble de modèles de DocFlex/XML Ce système logiciel permet de développer et d'exécuter des générateurs de documentation et de rapports très performants à partir de n'importe quelles données stockées dans des fichiers XML.

EXEMPLE

Voici une démonstration d'une telle documentation (elle a été générée par un seul fichier source : http://developer.ebay.com/webservices/latest/ebaySvc.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/

Answer 5

Je sais que c'est une méthode de documentation pour les pauvres, mais j'ai utilisé l'ouverture du XSD du wsdl dans Visual Studio et j'ai fait des impressions snag-it de cela avec des commentaires et des flèches ajoutés pour la clarté et notre client semble avoir aimé cela sans avoir à utiliser un autre outil. Il se peut aussi que vous ne disposiez pas de cet outil, mais vous pourriez utiliser une version d'un abonnement VPC ou MSDN gratuit. J'ai également utilisé l'éditeur de schémas BizTalk pour visualiser le XSD et le documenter à partir de là en utilisant snag-it ou une autre application de capture d'écran. J'essaierais d'utiliser ce que vous avez !

-Bryan