首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >wsdl:documentation标记是否支持xml:lang属性?

wsdl:documentation标记是否支持xml:lang属性?
EN

Stack Overflow用户
提问于 2012-12-06 16:24:55
回答 1查看 931关注 0票数 2

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

到目前为止,我还没有在网上找到任何东西,我简直不敢相信我是唯一一个想要做双语文档的人。有什么提示吗?

EN

回答 1

Stack Overflow用户

回答已采纳

发布于 2012-12-09 03:52:52

From the WSDL 1.1 specification

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

From the WSDL 2.0 specification (我的重点):

WSDL2.0使用可选的文档元素信息项作为人类可读或机器可处理文档的容器。元素信息项的内容是任意字符信息项和元素信息项( XML Schema XML Schema: Structures中的“混合”内容)。documentation元素信息项在任何WSDL2.0元素信息项中都是允许的。

与"http://www.w3.org/ns/wsdl“名称空间中的其他元素信息项一样,documentation元素信息项允许名称空间名称不是"http://www.w3.org/ns/wsdl”的合格属性信息项。 xml:lang属性(参见XML1.0)可用于指示文档元素信息项的内容中使用的语言。

这似乎在V1中以某种方式被遗忘了,并在V2中修复了。基本上,你要靠你自己。

但是,即使规范强制使用xml:lang来编写文档,您也永远不会知道客户将使用什么来处理您提供给他们的WSDL,也永远不会知道他们是否能够正确地从中提取文档。

我希望你不介意我这么说,但我认为你处理这个问题的方式是错误的。web服务的文档不会自动恢复到WSDL。是的,为了让您的客户端能够轻松地生成调用您的web服务所需的管道代码,提供WSDL是必需的,但它只是详细说明了调用的技术细节。它没有说明应该如何使用您的web服务。

YMMV,但在WSDL之外,您可能希望:

  • 首先概述您的them;
  • emphasize服务做什么;
    • 它的每个操作用于什么以及何时使用;
    • 参数的含义,每个操作有哪些约束(例如,一些无法用包含web service;
    • describe所需/返回的典型数据的XSD web SOAP消息示例增强的业务约束)可能会出现什么错误,它们会有什么代码/描述,以及如何排除them;
    • emphasize业务约束(我认为是红色粗体文本?!);如果您想要插入图片来描述整个architecture?
    • etc

    ,该怎么办?

在WSDL中添加所有这些细节将是有限制的。那么,如何使您的文档由WSDL和一个格式良好的(特定于语言的) PDF文件组成,其中包含我上面提到的细节?

票数 3
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/13739582

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档