如何在swagger模型中创建嵌套对象

时间:2019-11-19 20:04:13

标签: java swagger swagger-ui swagger-editor

我有一个类似

的对象
public GenericBO {

   private int id;

   private String code;

   private int parentId;

   private List<GenericBO> child = new ArrayList<GenericBO>();

  //getters and setters respectively
}

如何在大张旗鼓中为其创建模型?

1 个答案:

答案 0 :(得分:0)

注释嵌套或不嵌套的Swagger模型之间没有区别。

您必须向模型的每个属性添加io.swagger.annotations.ApiModelProperty注释。

public GenericModel {

   @ApiModelProperty(value = "ID")
   private int id;

   @ApiModelProperty(value = "Code")
   private String code;

   @ApiModelProperty(value = "Parent Id")
   private int parentId;

   @ApiModelProperty(value = "Children")
   private List<GenericModel> children = new ArrayList<>();

   ...
}

如果列表对象是其他模型的集合,则还必须注释相应的模型(带有@ApiModelProperty注释)。