如何在 swagger 2.0 中定义 <![CDATA[ ]]> 属性

Question

我正在使用 Swagger 来定义我的 api 定义。我有一个需要使用 swagger 定义的 cmets。

Answer 1

CDATA 不是 XML 逻辑结构的一部分，它只是指示包含特殊字符的文本的一种方式 - 以防止此类文本被解释为 XML 标记。

只需将 CDATA 的父元素定义为 type: string 即可。无需以任何方式指示 CDATA 标记。必要时由服务器和客户端将 XML 元素的文本作为 CDATA 发送。

例如

<root>
  <elem><![CDATA[ ... ]]></elem>
</root>

定义为：

swagger: "2.0"
...

definitions:
  root:
    type: object
    properties:
      elem:
        type: string