Java中apimodel_java - 列表的swagger @ApiModelProperty示例值

我有一类,其中有一个属性是List

public class MyClass {

....

@ApiModelProperty(position = 2)

private List productIdentifiers;

....

}

此代码生成示例值,如下所示:

{

"customerId": "1001",

"productIdentifiers": [

"string"

],

"statuses": [

"NEW"

]

}

此处显示的示例值无效。 我期望的示例值应类似于:

{

"customerId": "1001",

"productIdentifiers": [

"PRD1",

"PRD2",

"PRD3"

],

"statuses": [

"NEW"

]

}

我尝试过按以下方式传递示例属性,但未生成正确的值:

@ApiModelProperty(position = 2, example = "PRD1, PRD2, PRD3")

// This generates -> "productIdentifiers": "PRD1, PRD2, PRD3" // Its not json array

@ApiModelProperty(position = 2, example = "[\"PRD1\", \"PRD2\", \"PRD3\"]")

// This generates -> "productIdentifiers": "[\"PRD1\", \"PRD2\", \"PRD3\"]" // Its too not json array

有什么办法可以为List属性生成适当的示例值?

更新:

我已经尝试了@nullpointer和@Zeeshan Arif建议的解决方案

@ApiModelProperty(position = 2, dataType="List", example = "PRD1, PRD2, PRD3")

private List productIdentifiers;

//This generates -> `"productIdentifiers": "PRD1, PRD2, PRD3"`

更新2:

尝试了以下方法, 但未产生适当的响应

@ApiModelProperty(position = 2, dataType="java.util.List", example = "PRD1, PRD2, PRD3")

// This generates -> "productIdentifiers": "PRD1, PRD2, PRD3"

@ApiModelProperty(position = 2, dataType="String[]", example = "PRD1, PRD2, PRD3")

// This generates -> "productIdentifiers": "PRD1, PRD2, PRD3"

我对swagger jar的maven依赖是:

io.springfox

springfox-swagger2

2.5.0

mapstruct

org.mapstruct

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值