Swagger @Example与@ExampleProperty使用无效原因分析
更新时间：2026年03月11日 09:27:45 作者：很倔也很天真
Swagger@Example与@ExampleProperty无效的原因是Swagger默认UI不支持显示这些配置,即使后端返回的数据中有配置的内容
Swagger @Example与@ExampleProperty使用无效
code string example: 123321 验证码 password string example: pwd123456 密码 phone string example: 13633731313 手机号 username string example: account1001 用户名
@ApiImplicitParams(
@ApiImplicitParam(name = "form", value = "手机登录表单",
examples = @Example(
@ExampleProperty(value = "{\"code\": 123321,\"phone\": \"13633731313\"}", mediaType = "application/json")
))
)
预想显示结果
{
"code": 123321,
"phone": 13633731313
}
但Swagger默认UI只会显示
{
"code": 123321,
"password": "pwd123456",
"phone": 13633731313,
"username": "account1001"
}
原因是UI不支持显示
但后端返回数据中有配置的内容
参照没有使用配置的接口可以发现，当他发现有实体的时候就直接使用实体中的描述来显示了。
总结
以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。
相关文章
Yolo（You Only Look Once）是一种基于深度学习的目标检测算法,它可以在一张图像中同时检测出多个目标,并给出它们的位置和类别,这篇文章主要介绍了使用Java调用Yolo模型的基本步骤,需要的朋友可以参考下2024-03-03
这篇文章主要来和大家探讨一下Spring中的@Lazy注解为什么能破解死循环，文中的示例代码讲解详细，具有一定的参考价值，需要的可以了解一下2023-07-07
springboot启动脚本start.sh和停止脚本 stop.sh的详细教程
这篇文章主要介绍了springboot启动脚本start.sh和停止脚本 stop.sh的详细教程,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下2020-08-08
这篇文章主要介绍了rocketMQ如何避免消息重复消费问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教2024-06-06
这篇文章主要介绍了JPA分类表的操作函数，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习吧2023-02-02
本篇文章介绍了一个关于密钥查询的jsp文件简单实例代码，需要的朋友可以参考下2017-04-04
作为Java开发者,经常创建很多对象,你是否知道Java中创建对象有哪些方式呢?下面这篇文章主要给大家介绍了关于Java创建对象的六种常用方式,文中通过代码介绍的非常详细,需要的朋友可以参考下2024-06-06
这篇文章主要介绍了Java打包及上传到私服务的方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧2024-01-01
压缩就是通过某种技术（算法）把原始文件变下，相应的解压就是把压缩后的文件变成原始文件，本文给大家分享Hadoop中的压缩知识，感兴趣的朋友跟随小编一起看看吧2021-12-12
这篇文章主要介绍了详解SpringBoot接收参数使用的几种常用注解,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2022-08-08
最新评论