wsdl：documentation标记是否支持xml：lang属性？

Question

我必须为现有的WSDL文件编写文档，并且更愿意在文档中这样做。问题是，我找不到任何关于wsdl：documentation是否允许使用xml：lang作为属性或者任何文档生成器是否会使用它。

到目前为止，我还没有在网上找到任何内容，我根本无法相信我是唯一一个想要双语文档的人。任何提示？

Answer 1

From the WSDL 1.1 specification：

  

WSDL使用可选的wsdl：document元素作为人类可读文档的容器。元素的内容是任意文本和元素（在XSD中“混合”）。任何WSDL语言元素都允许使用documentation元素。

From the WSDL 2.0 specification（强调我的）：

  

WSDL 2.0使用可选的文档元素信息项作为人类可读或机器可处理文档的容器。元素信息项的内容是任意字符信息项和元素信息项（XML Schema [XML Schema：Structures]中的“混合”内容）。任何WSDL 2.0元素信息项中都允许使用documentation元素信息项。

     

与“http://www.w3.org/ns/wsdl”命名空间中的其他元素信息项一样，文档元素信息项允许[命名空间名称]不是“http://www.w3.org/ns/wsdl”的限定属性信息项。 xml：lang属性（参见[XML 1.0]）可用于指示文档元素信息项的内容中使用的语言。

似乎这在V1中被遗忘并在V2中修复。基本上，你是独立的。

但即使规范要求使用xml：lang进行文档编制，您也永远无法知道客户端将使用什么来处理您提供的WSDL，并且永远不知道他们是否可以正确地从中提取文档。< / p>

我希望你不介意我说这个，但我认为你正在以错误的方式接近这一点。 Web服务的文档不会自行恢复到WSDL。是的，提供WSDL是必需的，以便您的客户能够轻松生成调用Web服务所需的管道代码，但它仅详细说明了调用的技术细节。它没有说明如何使用您的Web服务。

YMMV但除了WSDL之外，你可能想要：

• 首先概述您的网络服务;
• 每个操作的用途和时间;
• 参数的含义是什么，每个参数有哪些约束（例如，某些业务约束无法通过XSD限制加强）;
• 包含Web服务需要/返回的典型数据的一些SOAP消息示例;
• 描述了预期的错误，它们将具有哪些代码/描述以及如何对其进行故障排除;
• 强调业务限制（我在想红色粗体文字？！）;
• 如果您想插入图片来描述整体架构，该怎么办？
• 等等

在WSDL中添加所有这些细节将是限制性的。那么如何使您的文档由WSDL和格式良好（特定于语言）的PDF文件组成，其中包含我上面提到的详细信息？