我正在为以下 XML 有效负载构建 OpenAPI (Swagger) 2.0 定义,以在 Swagger UI 中使用:
<addressElement>
<key type="RECORD_ID" item="3">Enter value here</key>
</addressElement>
我在弄清楚如何显示元素的默认值“在此处输入值”时遇到问题key
。应该将该默认值放在 OpenAPI 定义中的什么位置?我的定义如下:
"definitions": {
"addressElement": {
"type": "object",
"title": "Address Element",
"properties": {
"key": {
"type": "object",
"properties": {
"type":{
"type": "string",
"example": "RECORD_ID",
"xml":{
"attribute": true
}
},
"item":{
"type": "integer",
"format": "int64",
"example": "3",
"xml":{
"attribute": true
}
}
}
},
},
"xml": {
"name": "addressElement"
}
}
}
目前这是不可能的,因为 OpenAPI 没有办法用属性来表示 XML 元素,例如
<key type="RECORD_ID" item="3">Enter value here</key>
只能为对象定义属性
<obj attr="value">
<elem>Some text</elem>
</obj>
但不是为了简单<elem>text</elem>
元素。
这里有一个关于此限制的未决问题:
如何用属性表示 XML 元素 https://github.com/OAI/OpenAPI-Specification/issues/630
也就是说,OpenAPI 规范维护者正在考虑使用一个选项替代数据建模模式 https://github.com/OAI/OpenAPI-Specification/issues/1532(例如 XSD Schema),因此 OpenAPI 的未来版本可能会支持您的用例。
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)