web-dev-qa-db-ja.com

WSDLからHTMLドキュメントを生成する

WSDLから何らかの人間が読めるドキュメントを生成するためのあなたのアプローチは何ですか？過去に WSDL viewer （Tomi Vanekによる）を使用しましたが、結果には満足していますが、可能な代替案に興味があります。

x3sp についても聞いたことがありますが、試したことはありません。

web-servicesdocumentationwsdlnant
51
Igor Brejc

私はいくつかの選択肢を試しました

  • Webサービス用TechWriter ：非常に強力ですが、HTML出力はマルチファイルでした（コメントを参照）。また、コメントはそれが廃止されたことを示していますが、もはやそうではありません。
  • <oXygen /> XML Editor ：埋め込みスキーマを処理しません。
  • Altova XML Spy ：匿名型を処理しません。

そして、WSDLビューアーを私のニーズに合わせて調整することになりました。

20
fglez

http://code.google.com/p/wsdl-viewer/ およびcygwinのxsltprocを使用します

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

魔法のように働く

8
Tomáš Fejfar

はい、新しいものがあります： wsdl2html 。要求/応答に焦点を当て、人々が気にしない情報を削除します。

8
Jian Chen

ここにはリストされていませんが、 SoapUI には便利なwsdlドキュメントジェネレーターがあります。

プロジェクトを右クリックして、「ドキュメントの生成」を選択します。

7
Halfstop

これには、「 DocFlex/XML WSDLDoc 」と呼ばれるもう1つのツールがあります。

これは新しいWSDL/XSDドキュメントジェネレーターであり、WSDLファイルとXMLスキーマ（XSD）ファイルとそれらの間の相互接続をいくつでもドキュメント化できます。

Altova XMLSpyまたはOxygen XMLによって生成されたXSD図を自動的に含めるオプションもあります。効果的に、それらのいずれも、動的にリンクされたダイアグラムエンジンとして使用できます。

主な機能

  • 単一フレーム（Javadocライク）の生成HTMLドキュメンテーション任意の数のWSDL/XSDファイルによる。 （入力ファイルが多すぎる場合は、Antのようなパス名パターンを使用してすべてを選択できます）。
  • 次を含む任意の数のXMLスキーマ（WSDLとともに）の処理：
    • 個別のXSDファイルの形式で
    • WSDLに埋め込まれたXMLスキーマ（<wsdl:definitons>/<wsdl:types>要素内）
  • referenced WSDLファイルとXMLスキーマの処理、特に：
    • 関係するすべてのWSDL/XSDファイルで見つかったすべての<wsdl:import>、<xs:import>、<xs:include>、<xs:redefine>要素の正しい処理。
    • すべての直接的/間接的に参照されるWSDL/XSDファイルの自動読み込みおよび処理（つまり、ドキュメントの範囲に含める）。
  • XSDコンポーネント（XMLスキーマドキュメント）の高度なドキュメント化：
    • XMLスキーマ設計パターンのサポート。
    • XSDダイアグラムXMLSpy または Oxygen XML のいずれかによって生成され、すべてのダイアグラムハイパーリンクをサポートする自動包含の可能性。
  • すべての文書化相互接続 WSDL定義とXSDコンポーネント間の::
    • WSDLメッセージから、メッセージデータを記述するXSD要素/タイプの詳細へのハイパーリンク。
    • XSD要素/タイプの詳細で、それらが使用されるすべてのWSDL定義のリスト。
    • XSD要素/タイプの注釈を、それらが使用されるWSDLメッセージ（および操​​作）のドキュメントにコピーします。
  • 無制限カスタマイズの可能性。 WSDLDocは、実際には DocFlex/XML のテンプレートセットです。XMLファイルに格納されたデータから高性能のドキュメントとレポートジェネレーターを開発および実行するためのソフトウェアシステムです。

[〜＃〜] example [〜＃〜]

そのようなドキュメントのデモを次に示します（単一のソースファイルによって生成されました： http://developer.ebay.com/webservices/latest/ebaySvc.wsdl ）：

eBay Trading API - WSDL documentation

HTML自体： http://www.filigris.com/docflex-xml/wsdldoc/examples/html/ebaySvc/index.html

[〜＃〜] links [〜＃〜]

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

5
Leonid Rudy

Xml ToolsプラグインがインストールされたNotepad ++でもxsl変換を実行できることを発見しました。前述のwsdl-viewer.xslとwsdlファイルを提供すると、結果として適切にフォーマットされたhtmlが得られます。

3
Patrick Koorevaar

AltovaのXMLSpyは、WSDLからHTMLドキュメントを生成します...しかし、無料ではありません;）

2
Alexandre Victoor

私はこれが貧乏人の文書化方法であることを知っていますが、Visual StudioでWSDLのXSDを開き、コメントと矢印を明確に追加してスナッグイット印刷を行い、顧客は別のツールを使用せずにそれを気に入っているようです。また、これがない場合もありますが、無料のVPCまたはMSDNサブスクリプションのバージョンを使用できます。また、BizTalkスキーマエディターを使用してXSDを表示し、snag-itまたは別のスクリーンキャプチャアプリを使用してそこから文書化します。私はあなたが持っているものを使ってみます！

-ブライアン

1
Bryan Corazza

JDKの一部である「wsimport」を使用して、生成されたファイルでJavadocを実行できます。あなたが注釈を入れたと仮定すると、それはそれらをドキュメントの一部として入れます。

別のツールとして、Rational Application Developerを使用すると、右クリックして、かなりハイパーリンクされた画像を含むHTMLドキュメントを生成できます。

0
Archimedes Trajano

IDocItを使用できます！ WSDLを文書化し、文書をHTMLにエクスポートします。これは、ダウンロード可能なオープンソースのEclipseプラグインです こちら 。

テーマグリッドとテーマロールを使用してドキュメントを作成する新しいアプローチを提供しますが、使用する必要はありません。ドキュメントはプレーンテキストのままで作成できます。

0
Dirk