Swagger XML属性和内容定义

时间:2017-02-03 12:02:43

标签: xml rest swagger swagger-ui swagger-editor

我想用swagger描述RESTful接口的XML响应有效负载。但是,我很难在swagger数据模型中描述特定的XML标记。

我无法通过这种形式创建适当的示例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>

正如你所看到的,没有&#34; foo&#34;那里的内容。

提前感谢任何有用的提示!

1 个答案:

答案 0 :(得分:1)

不幸的是,没有办法用OpenAPI Specification 2.0来表示它。

正在跟踪此问题here,可以在规范的未来版本中解决。