Как отобразить взаимоисключающие поля в модели API в интерфейсе Swagger - PullRequest
Новая
       19

Как отобразить взаимоисключающие поля в модели API в интерфейсе Swagger

0 голосов
/ 27 апреля 2018

Есть ли аннотация или способ правильно отображать взаимоисключающие поля в модели API (JSON) в swagger? например. Если у меня есть следующая API-модель, и я хочу показать, что поля A и B являются взаимоисключающими, например, Класс Java говорит, что AtoZ имеет следующую структуру 

class AtoZ {
   String A;
   String B;
   @ApiModelProperty(value ="This is field C", required = true)
   String C;
}

Пусть, например, поле C является обязательным, как указано выше, но поля A и B являются взаимоисключающими, т. Е. Требуется только одно поле / оно может существовать. Если и A, и B аннотированы как Необязательные (то есть обязательные = ложные), это не приведет к применению взаимоисключающих ограничений.

Хотите знать, есть ли в swagger какая-либо соответствующая аннотация, позволяющая документировать такую ​​структуру в интерфейсе Swagger?

...