xml - 在 OpenAPI 中，如何定义具有属性和内容的 XML 元素？

Question

我想用 OpenAPI 2.0 (Swagger 2.0) 描述 RESTful 接口(interface)的 XML 响应负载。但是，我很难在 OpenAPI 数据模型中描述特定的 XML 标记。

我无法让 Swagger UI 以这种形式创建适当的示例 XML 标记，在开始和结束 XML 标记之间具有属性 和 内容:

<Person id="bar">foo</Person>

文档 ( here ) 仅描述了如何为带有子标签 (type: object) 的标签或带有内容 (type: string) 的标签建模，但不能同时进行。

我试过了，Swagger 编辑器接受了，没有任何错误或警告:

definitions:
  Person:
    type: string
    example: foo
    properties:
      id:
        type: string
        example: bar
        xml:
          attribute: true

但是它会被 Swagger UI 渲染到下面的例子中:

<Person id="bar"></Person>

如您所见，其中没有“foo”内容。

Answer 1

不幸的是，无法使用 OpenAPI Specification 2.0 来表示它、3.0 或 3.1

正在跟踪此问题 here并且可以在规范的 future 版本中解决。