Как дать несколько примеров значений для одного и того же объекта, используя swagger

Question

Я создал один класс Model (Product), он содержит два имени и значения. Я хотел бы дать значения по умолчанию swagger для модели продукта. Я смог сделать это с помощью аннотации @ApiModelProperty, и она работает нормально. Но мое реальное требование - дать несколько значений для одного и того же объекта примерно так:

{
  "products": [
    {
      "name": "X",
      "value": "100"
    },
    {
      "name": "Y",
      "value": "100"
    },
    {
      "name": "Z",
      "value": "100"
    },
    {
      "name": "A",
      "value": "01"
    }
  ]
} 

этой модели по умолчанию, которую я пытаюсь создать для запроса HTTP POST, как я могу добиться этого с помощью swagger2 и springboot

Answer 1

Вы должны пометить поле как datatype="List"

public class MyClass {
....
@ApiModelProperty(datatype="List", example = "'['{'name': 'X','value': '100'}']")
private List< Product> products;
....
}

Редактировать

public class MyClass {
....
@ApiModelProperty(value = "{\n'name':'X',\n'value':'100'\n},\n{\n'name':'Y',\n'value':'100'\n}")
private List< Product> products;
....
}