从WSDL生成HTML文档

从WSDL生成某种人类可读文档的方法是什么? 在过去,我使用过WSDL查看器 (Tomi Vanek)(请参阅我的博客文章,将其集成到NAnt中 ),我对结果感到满意,但我对任何可能的替代方法感兴趣。

我也听说过x3sp ,但是我没有尝试过。

我尝试了几个select

  • 用于Web服务的TechWriter :function非常强大,但HTML输出是(见注释)多文件。 此外,评论表明它已经退休,但情况已经不复存在。
  • <oXygen /> XML编辑器 :它不处理embedded式模式。
  • Altova XML Spy :它不处理匿名types。

最后根据我的需要调整了WSDL查看器。

使用http://code.google.com/p/wsdl-viewer/和cygwin的xsltproc

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

奇迹般有效

是的,有一个新的: wsdl2html 。 它侧重于请求/响应,并删除人们不关心的信息。

现在,还有一个工具叫做“ DocFlex / XML WSDLDoc ”。

它是一个新的WSDL / XSD文档生成器,它允许您logging任意数量的WSDL和XML模式(XSD)文件以及它们之间的任何互连。

还可以select自动包含由Altova XMLSpy或Oxygen XML生成的XSD图表。 实际上,它们中的任何一个都可以用作dynamic链接的图表引擎。

主要特征

  • 通过任意数量的WSDL / XSD文件生成单个框架(类似Javadoc的) HTML文档 。 (如果你有太多的input文件,你可以使用类似Ant的path名模式来选取它们)。
  • 处理任何数量的XML模式 (以及WSDL),包括:
    • 以单独的XSD文件的forms
    • embedded在WSDL中的XML模式(在<wsdl:definitons>/<wsdl:types>元素中)
  • 处理任何引用的 WSDL文件和XML模式,特别是:
    • 正确处理在所有涉及的WSDL / XSD文件中find的所有<wsdl:import><xs:import><xs:include><xs:redefine>元素。
    • 自动加载和处理(即包含在文档范围内)所有直接/间接引用的WSDL / XSD文件。
  • XSD组件的复杂文档(XML模式文档):
    • 支持任何XML模式devise模式。
    • 自动包含由XMLSpy或Oxygen XML生成的XSD图表的可能性,并支持所有图表超链接。
  • loggingWSDL定义和XSD组件之间的所有互连
    • 从WSDL消息到描述消息数据的XSD元素/types的细节的超链接。
    • 在XSD元素/types细节中,使用它们的所有WSDL定义的列表。
    • 将XSD元素/types的注释复制到使用它们的那些WSDL消息(甚至操作)的文档中。
  • 无限定制的可能性。 WSDLDoc实际上是一个为DocFlex / XML设置的模板, DocFlex / XML是一个用于从XML文件中存储的任何数据开发和执行高性能文档和报告生成器的软件系统。

下面是这样的文档演示文稿(它是由一个源文件生成的: http :

eBay Trading API  -  WSDL文档

HTML本身: http : //www.filigris.com/docflex-xml/wsdldoc/examples/html/ebaySvc/index.html

链接

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

这里没有列出,但是SoapUI有一个有用的wsdl文档生成器。

右键单击您的项目,然后select“生成文档”。

Altova的XMLSpy不会从WSDL生成HTML文档,但它不是免费的;)

我刚刚发现安装了Xml Tools插件的Notepad ++也可以做xsl转换。 如果你提供了前面提到的wsdl-viewer.xsl和wsdl文件,你将得到一个很好格式化的html。

我知道这是一个穷人的文档方法,但我已经用Visual Studio打开了wsdl的XSD,并且做了一些细节处理,并且为了清晰起见添加了注释和箭头,我们的客户似乎喜欢它,而不必使用其他工具。 您也可能没有这个,但可以使用免费的VPC或MSDN订阅的版本我也使用BizTalk架构编辑器来查看XSD,并从那里使用snag-it或其他屏幕捕获应用程序来logging它。 我会尽量使用你所拥有的!

布莱恩

您可以使用作为JDK一部分的“wsimport”,并在生成的文件上运行Javadoc。 假设你已经把注释放在文档中。

另一个工具是Rational Application Developer,它允许你右键点击并用漂亮的超链接图片生成HTML文档。

你可以使用iDocIt! logging一个WSDL并导出文档到HTML。 这是一个开源的Eclipse插件在这里下载。

它提供了创build具有专题网格和专题angular色的文档的新方法,但是您不需要使用它们。 您仍然可以以纯文本forms创build文档。