如何在Swagger UI中显示API模型中的互斥字段

时间:2018-04-26 22:09:50

标签: swagger swagger-ui jsonschema swagger-2.0

是否有任何注释或方法可以在swagger中正确显示API模型(JSON)中的互斥字段? 例如。如果我有以下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都注释为Optional(即required = false),则不会强制执行互斥约束。

想知道swagger中是否有任何适当的注释允许在Swagger UI中记录这种结构?

0 个答案:

没有答案