Как определить атрибут <! [CDATA []]> в Swagger 2.0 - PullRequest
Новая
       39

Как определить атрибут <! [CDATA []]> в Swagger 2.0

0 голосов
/ 15 января 2019

Я работаю с Swagger, чтобы определить мое определение API. У меня есть комментарии, которые мне нужно определить, используя чванство.

1 Ответ

0 голосов
/ 06 февраля 2019

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
...