从WSDL生成HTML文档

55
从WSDL生成可读性强的文档的方法是什么?过去我使用过WSDL viewer(由Tomi Vanek制作),结果很满意,但我对其他可能的替代方案也感兴趣。
我也听说过x3sp,但我还没有尝试过。
10个回答

23

我尝试了几种替代方案:

最终,我改进了 WSDL 查看器以满足我的需求。


4
TechWriter for Web Services 的当前版本还支持单页 HTML 输出。 - Bernard Vander Beken
3
一样的情况。我使用了WSDL查看器,SoapUI Pro也用它哈哈。 - Nicholas DiPiazza
2
TechWriter已经停用了...有人可以分享一个许可证号码吗? - willyMon
1
我认为TechWriter的链接已经过时了,这可能是新的链接:https://techwriter.me。 - damjad

11
是的,有一个新的工具:wsdl2html。它专注于请求/响应并删除人们不关心的信息。

我尝试使用这个,但是我没有得到完整的服务列表。只有我的27个服务中的一个被显示出来。 - Lai
我喜欢wsdl2html的简洁性,这使得它非常方便地传达服务的基本信息,而不会让观众感到困惑。在我看来,唯一缺失的重要功能是获取操作和元素的描述/注释。 - Juanal
2
嗨,我已经更新了链接。现在它托管在Github上。 - Jian Chen

11

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

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


1
似乎使用了之前提到的wsdl-viewer.xsl(已移至Apache Woden),输出看起来相同。 - Clauds
工作得非常好。我已经在SOAPUI中创建了一个项目,它为我创建了一个漂亮的HTML页面。 - MattC

8

1
一开始看起来像是不同的产品,但现在我可以看出它们是一样的:)) - Tomáš Fejfar
工作得很好,但如果伴随着外部文件,它不会深入到XSD。我还必须使用这个+模式查看器。 - Nicholas DiPiazza

5
现在,有一个名为"DocFlex/XML WSDLDoc"的工具可用于此项任务。
它是一款新的WSDL/XSD文档生成器,可以帮助您记录任意数量的WSDL和XML Schema(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模式设计模式。
    • 可能自动包含由XMLSpyOxygen XML生成的XSD图表,支持所有图表超链接。
  • 文档编写WSDL定义和XSD组件之间的所有互联关系
    • 从WSDL消息到描述消息数据的XSD元素/类型的详细信息的超链接。
    • 在XSD元素/类型详细信息中,它们被使用的所有WSDL定义的列表。
    • 将XSD元素/类型的注释复制到它们被使用的那些WSDL消息(甚至操作)的文档中。
  • 无限定制自定义的可能性。WSDLDoc实际上是DocFlex/XML的模板集,DocFlex/XML是一种软件系统,用于开发和执行高性能文档和报告生成器,可以从存储在XML文件中的任何数据中生成。

示例

这是这样的文档的演示(它是由单个源文件生成的: http://developer.ebay.com/webservices/latest/ebaySvc.wsdl):

eBay Trading API - WSDL documentation

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

我已经使用XML文档产品相当长的一段时间了,我对产品的质量非常满意......可惜我的公司没有预算购买一些许可证,但我很高兴为自己购买了一个... - Pierluigi Vernetto
似乎是商业产品,需要许可证才能获得完整的功能。 - Venkatesh Muniyandi

4

我刚刚发现安装了Xml Tools插件的Notepad++也可以进行xsl转换。如果您提供之前提到的wsdl-viewer.xsl和wsdl文件,您将得到一个漂亮格式化的HTML结果。


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

3
Altova的XMLSpy可以从WSDL生成HTML文档,但它不是免费的。

1

我知道这是一种简陋的文档编写方法,但我曾经在Visual Studio中打开wsdl的XSD,并添加注释和箭头以增加清晰度,然后使用Snag-it进行截图,我们的客户似乎很喜欢它,而不需要使用其他工具。你可能没有这个,但可以使用来自免费VPC或MSDN订阅的版本。我也曾使用BizTalk模式编辑器查看XSD,并使用Snag-it或其他屏幕捕获应用程序对其进行文档化。我建议尽可能利用现有资源!

-Bryan


0

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

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


0

您可以使用iDocIt!来记录WSDL并将文档导出为HTML。它是一个开源的Eclipse插件,可以在这里下载。

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


网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接