我正在使用可以返回XML和JSON的API，并且正在研究是否有任何方法可以在Swagger中表示XML模式，并且看起来没有。
我有2个跟进问题：
如果我的XML返回API之一在'example'对象中发布了XML示例，那还好吧？
模式对象具有XML对象。我阅读了说明，但不确定将其用于什么情况？有人可以举个例子吗？如果可以的话，这真的很有帮助。
我只想确保我没有遗漏任何可以使我的API元数据更具描述性的东西。
谢谢你们。
谈到返回XML和JSON的API时，Swagger假定它们共享一个基本可互换的通用结构。
也就是说，如果您具有以下JSON：
{ "key1": "value1", "key2": "value2" }
XML如下所示：
<object>
<key1>value1</key1>
<key2>value2</key2>
</object>
如您所见，仍然存在细微差异。XML需要一个包含元素，该元素在JSON中不存在。这是Swagger Spec中XML对象出现的地方，因为它允许您添加此附加信息。它还允许您将字段定义为属性，声明使用的名称空间，并更好地控制值的数组，这些数组在XML中具有与JSON相反的XML变体。
虽然我们没有大量的XML对象样本，但是您可以在这里找到一个样本-https: //github.com/swagger-api/swagger-spec/blob/master/fixtures/v2.0/json/ models / modelWithXmlAttributes.json。我需要在规范中为其添加更多详细信息，希望在接下来的几周内。
至于示例字段-它的值是一个自由格式的JSON对象。您可以做的是这样的：
{
"xml" : "<object>.....</object>"
}
本文收集自互联网，转载请注明来源。
如有侵权，请联系 [email protected] 删除。
我来说两句