从WSDL生成HTML文档

Question

从WSDL生成某种人类可读文档的方法是什么？ 在过去，我使用了WSDL viewer（作者Tomi Vanek）（见my blog post about integrating it into NAnt），我对结果感到满意，但我对任何可能的替代方案感兴趣。

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

Answer 1

我尝试了几种替代方案

• TechWriter for Web Services：非常强大，但HTML输出是（见注释）多文件。此外，评论表明它已经退役，但情况已不再如此。
• <oXygen/> XML Editor：它不处理嵌入式架构。
• Altova XML Spy：它不处理匿名类型。

并最终根据我的需要调整WSDL查看器。

Answer 2

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

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

像魅力一样工作

Answer 3

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

Answer 4

此处未列出，但SoapUI有一个有用的wsdl文档生成器。

右键单击您的项目，然后选择＆＃34;生成文档。＆＃34;

Answer 5

现在，还有一个工具，名为“DocFlex/XML WSDLDoc”。

这是一个新的WSDL / XSD文档生成器，它允许您记录任意数量的WSDL和XML模式（XSD）文件以及它们之间的任何互连。

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

主要功能

• 通过任意数量的 WSDL / XSD文件一起生成单帧（类似Javadoc） HTML文档。 （如果输入文件太多，可以使用类似Ant的路径名模式选择它们。）
• 处理任意数量的 XML模式（以及WSDL），包括：
  • 以单独的XSD文件的形式
  • 嵌入在WSDL中的XML模式（在<wsdl:definitons>/<wsdl:types>元素内）
• 处理任何引用的 WSDL文件和XML模式，特别是：
  • 正确处理所有相关WSDL / XSD文件中找到的所有<wsdl:import>，<xs:import>，<xs:include>，<xs:redefine>元素。
  • 自动加载和处理（即包含在文档范围内）所有直接/间接引用的WSDL / XSD文件。
• XSD组件（XML架构文档）的复杂文档：
  • 支持任何XML架构设计模式。
  • 自动包含XMLSpy或Oxygen XML生成的 XSD图表的可能性，并支持所有图表超链接。
• 在WSDL定义和XSD组件之间记录所有互连：
  • 从WSDL消息到描述消息数据的XSD元素/类型的详细信息的超链接。
  • 在XSD元素/类型详细信息中，使用它们的所有WSDL定义的列表。
  • 将XSD元素/类型的注释复制到使用它们的那些WSDL消息（甚至操作）的文档中。
• 无限自定义的可能性。 WSDLDoc实际上是DocFlex/XML的模板集，http://developer.ebay.com/webservices/latest/ebaySvc.wsdl是一个软件系统，用于从存储在XML文件中的任何数据开发和执行高性能文档和报告生成器。

示例

以下是此类文档的演示（它由单个源文件生成： http://www.filigris.com/docflex-xml/wsdldoc/examples/html/ebaySvc/index.html）：

HTML本身：http://www.filigris.com/docflex-xml/wsdldoc/

<强>链接

{{3}}

Answer 6

我刚刚发现安装了Xml Tools插件的Notepad ++也可以进行xsl转换。如果你提供前面提到的wsdl-viewer.xsl和wsdl文件，那么你将获得格式良好的html。

Answer 7

Altova的XMLSpy确实从WSDL生成HTML文档 ......但它不是免费的;）

Answer 8

我知道这是一个穷人的文档方法，但我已经习惯在视觉工作室中打开wsdl的XSD，并且为了清晰起见而添加了注释和箭头，并且我们的客户似乎已经喜欢它而不需要使用其他工具。您也可能没有这个，但可以使用免费的VPC或MSDN订阅版本我也使用BizTalk架构编辑器查看XSD并使用snag-it或其他屏幕捕获应用程序从那里记录它。我会尝试使用你拥有的东西！

布莱恩

Answer 9

您可以使用“wsimport”，它是JDK的一部分，并在生成的文件上运行Javadoc。假设你已经加入了注释，它将把它们作为文档的一部分。

另一个工具是Rational Application Developer，它允许您右键单击并生成带有漂亮超链接图片的HTML文档。

Answer 10

你可以使用iDocIt！记录WSDL并将文档导出为HTML。它是一个可下载的开源Eclipse插件here。

它提供了一种使用主题网格和主题角色创建文档的新方法，但您无需使用它们。您仍可以纯文本形式创建文档。