从 WSDL 生成 HTML 文档 [关闭]答案

【问题标题】：Generating HTML documentation from WSDL [closed]从 WSDL 生成 HTML 文档 [关闭]
【发布时间】：2009-03-26 14:45:50
【问题描述】：

您有哪些方法可以从 WSDL 生成某种人类可读的文档？过去我使用过WSDL viewer（作者 Tomi Vanek），我对结果很满意，但我对任何可能的替代方案都很感兴趣。

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

【问题讨论】：

标签： web-services documentation wsdl nant

【解决方案1】：

我尝试了几种选择

TechWriter for Web Services：真的很强大，但是 HTML 输出是（见 cmets）多文件。此外，cmets 表示它已退役，但情况已不再如此。
<oXygen/> XML Editor：它不处理嵌入式架构。
Altova XML Spy：它不处理匿名类型。

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

【讨论】：

当前版本的 TechWriter for Web Services 也支持单页 HTML 输出。
这里也一样。我去了wsdl查看器。 soapui pro 也用了哈哈
TechWriter 已退休...有些人可以共享许可证号？
我认为 techwriter 的链接已经过时。这大概就是新的了。 techwriter.me

【解决方案2】：

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

【讨论】：

我尝试使用它，但没有获得完整的服务列表。我的 27 项服务中只显示了一项
我喜欢 wsdl2html 的简单性，它可以非常方便地传达有关服务的基本信息，而不会混淆观众。在我看来，唯一缺少的重要功能是获取操作和元素的描述/cmets。
嗨，我已经更新了链接。现在它托管在 github 上。

【解决方案3】：

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

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

像魅力一样工作

【讨论】：

一开始它看起来像不同的产品，但我现在可以看到它是一样的 :))
效果很好，但如果在外部附带文件，则不会深入到 XSD 中。我也必须使用这个 + Schema 查看器

【解决方案4】：

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

右键单击您的项目并选择“生成文档”。

【讨论】：

好像使用前面提到的wsdl-viewer.xsl（移到Apache Woden），输出看起来一样。
效果很好。已经在 SOAPUI 中创建了一个项目，它为我创建了一个漂亮的 html 页面。

【解决方案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 的模板集，这是一个软件系统，用于根据存储在 XML 文件中的任何数据开发和执行高性能文档和报告生成器。

示例

这是此类文档的演示（由单个源文件生成： http://developer.ebay.com/webservices/latest/ebaySvc.wsdl):

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

链接

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

【讨论】：

我使用 XML doc 产品已经有一段时间了，我对产品的质量非常满意.... 可惜我的公司没有预算购买一些许可证，但我很高兴为自己买了一个......
这似乎是商业产品，需要许可证才能获得全部功能

【解决方案6】：

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

【讨论】：

如果您使用带有 EE 功能的 Eclipse，它允许您通过简单地右键单击并选择运行来处理 XSLT 文件。

【解决方案7】：

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

【讨论】：

【解决方案8】：

我知道这是一个穷人的文档方法，但我已经使用在 Visual Studio 中打开 wsdl 的 XSD 并使用为清楚起见添加了 cmets 和箭头来进行打印，我们的客户似乎已经喜欢它而不必使用其他工具。您也可能没有这个，但可以使用来自免费 VPC 或 MSDN 订阅的版本我还使用 BizTalk 架构编辑器来查看 XSD，并使用 snag-it 或其他屏幕捕获应用程序从那里记录它。我会尝试使用你所拥有的！

-布莱恩

【讨论】：

【解决方案9】：

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

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

【讨论】：

【解决方案10】：

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

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

【讨论】：