2017-02-03 3 views
1

swagger로 RESTful 인터페이스의 XML 응답 페이로드를 설명하고자합니다. 그러나 필자는 비틀 거리는 데이터 모델에서 특정 XML 태그를 설명하는 데 어려움을 겪고 있습니다.Swagger XML 속성 및 내용 정의

내가 속성 와 개방 사이 내용과 닫는 XML 태그로,이 형태의 적절한 예를 들어 XML 태그를 만들 자신감 UI를 얻을 수

:

<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 

하지만이 다음 예제에 자신감-UI로 렌더링됩니다 : 당신으로

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

은 내가 자신감 편집기가 오류 또는 경고없이 받아들이는,이 시도 거기에 "foo"콘텐츠가 없습니다.

도움이 될만한 힌트를 미리 보내 주셔서 감사합니다!

답변

1

불행히도 OpenAPI Specification 2.0을 사용하여 표현할 방법이 없습니다.

이 문제는 here으로 추적되고 있으며 향후 버전의 사양에서 해결 될 수 있습니다.