java - 如何使用 swagger 为同一对象提供多个示例值

Question

我创建了一个模型类(产品)，它包含两个字段名称和值。我想为产品模型提供 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;
....
}