如何使用摇头给同一个对象提供多个示例值

时间:2019-10-16 08:46:27

标签: java spring-boot swagger swagger-ui swagger-2.0

我创建了一个Model类(产品),其中包含两个领域名称和值。 我想提供产品模型的默认值。我能够在@ApiModelProperty注释的帮助下做到这一点,并且工作正常。 但是我的实际要求是为同一对象提供多个值,例如

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

我正在尝试为HTTP POST请求创建此默认模型,如何使用swagger2和springboot实现这一目标

1 个答案:

答案 0 :(得分:0)

您应将文件标记为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;
....
}