场景：当参数为list等集合类型时，example的属性值如下：

@ApiModelProperty(value = "集合", required = true, example = "[x,y,z]")
private List<String> params;

页面显示的结果为：

{"params": "[x,y,z]"
}

而不是期待的：

{"params": ["x", "y" , "z"]
}

下面对参数为list时example的显示问题进行探究。

package com.morris.swagger.vo;import io.swagger.annotations.ApiModelProperty;
import lombok.Data;import java.util.List;@Data
public class ListReq {@ApiModelProperty(dataType = "List", example = "'[''{''value1''}','{''value2''}'']")private List<String> aaa01;@ApiModelProperty(dataType = "List", allowableValues = "value1, value2", allowEmptyValue = false)private List<String> aaa02;@ApiModelProperty(dataType = "List", allowableValues = "value1, value2", allowEmptyValue = true)private List<String> aaa03;@ApiModelProperty(allowableValues = "value1, value2", allowEmptyValue = false)private List<String> aaa04;@ApiModelProperty(allowableValues = "value1, value2", allowEmptyValue = true)private List<String> aaa05;@ApiModelProperty(dataType = "List", example = "value1, value2, value2")private List<String> aaa06;@ApiModelProperty(dataType = "[Ljava.lang.String;", example = "value1, value2, value2")private List<String> aaa07;@ApiModelProperty(dataType = "[Ljava.lang.String;")private List<String> aaa08;@ApiModelProperty(dataType = "[Ljava.lang.String;", example = "'[''{''value1''}','{''value2''}'']")private List<String> aaa09;@ApiModelProperty(dataType = "[Ljava.lang.String;", allowableValues = "value1, value2", allowEmptyValue = false)private List<String> aaa10;@ApiModelProperty(dataType = "[Ljava.lang.String;", allowableValues = "value1, value2", allowEmptyValue = true)private List<String> aaa11;
}

运行后显示的结果如下：

{"aaa01": "'[''{''value1''}','{''value2''}'']","aaa02": {},"aaa03": {},"aaa04": ["string"],"aaa05": ["string"],"aaa06": "value1, value2, value2","aaa07": "value1, value2, value2","aaa08": ["string"],"aaa09": "'[''{''value1''}','{''value2''}'']","aaa10": ["string"],"aaa11": ["string"]
}

结论：ApiModelProperty doesn’t support example for arrays / Lists
。

详见：https://github.com/swagger-api/swagger-core/issues/3863

项目地址

https://gitee.com/morris131/swagger-demo

参考地址

https://github.com/swagger-api/swagger-ui
http://springfox.github.io/springfox/docs/current/

swagger参数为list时example的显示问题相关推荐

asp mysql分页_asp数据库编程:ADO 存取数据库时如何分页显示
∈裁词?ADO 存取数据库时的分页显示?如果你使用过目前众多网站上的电子公告板程序的话,那你应该会知道电子公告板程序为了提高页面的读取速度,一般不会将所有的帖子全部在一页中罗列出来,而是将其分成多页显 ...
echarts图表设置关于图例legend，限制图例可点击时最少保留显示一个图例
echarts图表设置关于图例legend,限制图例可点击时最少保留显示一个图例 echarts图表设置关于图例legend,限制图例可点击时最少保留显示一个图例,亲测有效: 代码如下: // 初始化 ...
Matplotlib：在图像上用中文进行标记时，不能显示中文，显示为方框
Matplotlib:在图像上用中文进行标记时,不能显示中文,显示为方框 1.问题背景 2.解决方法 1.问题背景首先,博主的系统环境如下: Win10 1709 教育版 Anaconda3-5. ...
数组作为函数的参数传参时，数组名会退化为指针
1.数组作为函数的参数传参时,数组名会退化为指针数组作为函数的参数传参时,数组名会退化为指针,数值传参时,需要把数值的长度一起传过去,另外,sizeof()运算符包含字符串的哨兵'/0',而strl ...
三线表是什么？R语言使用table1包绘制（生成）三线表、使用单变量分列构建三线表、通过topclass参数自定义三线表表格的显示形式（显示为类似斑马线、并将所有列居中，包括包含行标签的第一列）
三线表是什么?R语言使用table1包绘制(生成)三线表.使用单变量分列构建三线表.通过topclass参数自定义三线表表格的显示形式(显示为类似斑马线.并将所有列居中,包括包含行标签的第一列) 目录
linux dmesg命令参数及用法详解(linux显示开机信息命令)
功能说明:显示开机信息. 语法:dmesg [-cn][-s <缓冲区大小>] 补充说明:kernel会将开机信息存储在ring buffer中.您若是开机时来不及查看信息,可利用dme ...
使用“1”个参数调用“DownloadString”时发生异常:“操作超时”
使用"1"个参数调用"DownloadString"时发生异常:"操作超时" 参考文章: (1)使用"1"个参数调用&q ...
函数中参数有数组时注意的小问题（不一定要传递数组长度，不用返回数组，可以在函数中改变数组元素值）
函数中参数有数组时注意的小问题: 1.不一定要传递数组长度 2.不用返回数组,可以在函数中改变数组元素值通过下面这个小例子来验证: #include<iostream> #include ...
python 函数的调用的时候参数的传递_python定义函数时的参数调用函数时的传参...
一.定义函数: 1.位置参数:直接定义参数 2.默认参数(或者关键字参数):参数名 = "默认值" 3.位置参数必须在默认参数之前二.调用函数: 1.按位置传,直接写参数的值 2 ...

swagger参数为list时example的显示问题

项目地址

参考地址

swagger参数为list时example的显示问题相关推荐

最新文章

热门文章