如何在JSON模式中包含XML模式(.xsd)?

时间:2016-11-02 07:52:02

标签: xsd jsonschema api-design raml

我想使用JSON Schema定义JSON API响应。

嵌入在API响应中的一部分是一个完整的,格式良好的模式有效XML字符串。此XML字符串的XSD是给定的。

两部分问题:

  1. 如何在JSON模式中包含XSD,以使JSON模式还要求XML字符串具有模式有效性,以使整个API响应有效?

  2. 如果无法做到这一点,是否还有人建议如何至少在规范中包含XSD?我在RAML 0.8中工作。

1 个答案:

答案 0 :(得分:1)

  

如何在JSON模式中包含XSD,使其成为JSON模式   还需要XML字符串为架构有效,以便   整个API响应是否有效?

你做不到。您唯一能做的就是验证JSON,然后在稍后提取XML并单独验证它。

  

如果这是不可能的,有没有人有另外的建议如何   至少在规范中包含XSD?我在RAML工作   0.8。

我只使用Swagger,而不是RAML。 Swagger也基于JsonSchema。

这里唯一可以做的就是包含一个详细的规范,包含的XML应该符合这样的XSD。你可以使用"描述" swagger中的功能(或RAML中存在的等效功能)。这允许您创建描述(支持markdown)并将其附加到定义

中的任何元素