2017-02-03 2 views
1

Я хотел бы описать полезную нагрузку ответа XML интерфейса RESTful с swagger. Однако я не могу описать конкретный тег XML в модели данных swagger.XML-атрибут Swagger и определение содержимого

Я не могу чванство пользовательский интерфейс, чтобы создать соответствующий пример XML-тега в этой форме, с атрибутом и содержимого между открывающим и закрывающим тегами XML:

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

документация (here) только описывает, как моделировать тег с подтеками (type: object) или тег с контентом (type: string), но не оба одновременно.

Я попробовал это, что чванство-редактор принимает без каких-либо ошибок или предупреждений:

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

но это будет оказывать развязность-ш к следующему примеру:

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

Как вам может видеть, нет содержания «foo».

Заранее благодарим за полезные подсказки!

ответ

1

К сожалению, нет возможности представить это с помощью OpenAPI Specification 2.0.

Эта проблема отслеживается here и может быть рассмотрена в будущих версиях спецификации.

Смежные вопросы