How to give multiple example values for same object using swagger

Question

I have created one Model class(Product),it contains two feilds name and value. I would like to give swagger default values for Product model. I was able to do it with the help of @ApiModelProperty annotation and it's working fine. But my actual requirement is to give multiple values for same object something like this

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

this default model I am trying to create for HTTP POST request how can I achieve this with swagger2 and springboot

user_10383493 · Answer

You should mark the filed with datatype="List"

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

Edit

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

How to give multiple example values for same object using swagger

1 Answers