How can I create a nested object in swagger model

Question

I have a object like

public GenericBO {

   private int id;

   private String code;

   private int parentId;

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

  //getters and setters respectively
}

How can I create the model for the same in swagger?

Do you write the OpenAPI definition manually or generate it from code? — Helen
– Helen, Commented Nov 20, 2019 at 7:49
Check out Springfox or Swagger Core. Vladlas Maier's answer below shows how you would annotate the code. — Helen
– Helen, Commented Nov 21, 2019 at 7:34

Vladas Maier · Accepted Answer · 2019-11-20 07:44:07Z

1

There is no difference between annotating nested or not nested Swagger models.

You have to add io.swagger.annotations.ApiModelProperty annotation to each attribute of the model.

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<>();

   ...
}

If the list object is a collection of other models you must annotate the corresponding model (with @ApiModelProperty annotations) as well.

answered Nov 20, 2019 at 7:44

Vladas Maier

2,1822 gold badges25 silver badges37 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

How can I create a nested object in swagger model

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related