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不支持显示
但后端返回数据中有配置的内容
参照没有使用配置的接口可以发现，当他发现有实体的时候就直接使用实体中的描述来显示了。
总结
以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。
相关文章
这篇文章主要介绍了使用Feign远程调用时,序列化对象失败的解决方案，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2021-07-07
这篇文章主要介绍了springboot下使用mybatis的方法,需要的朋友可以参考下2017-11-11
java+jdbc+mysql+socket搭建局域网聊天室
这篇文章主要为大家详细介绍了java+jdbc+mysql+socket搭建局域网聊天室，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2019-01-01
这篇文章主要介绍了spring boot mybatis全注解化的相关资料,需要的朋友可以参考下2017-09-09
Maven编译遇到Process terminated问题(四种情况全部解决)
这篇文章主要介绍了Maven编译遇到Process terminated问题(四种情况全部解决),具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教2024-07-07
SpringBoot应用中,调用外部接口是微服务架构常见需求,本文主要介绍了SpringBoot调用外部接口的几种方式,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧2024-10-10
ScheduledExecutorService任务定时代码示例
这篇文章主要介绍了ScheduledExecutorService任务定时代码示例，具有一定借鉴价值,需要的朋友可以参考下2018-01-01
SpringBoot使用EmbeddedDatabaseBuilder进行数据库集成测试
在开发SpringBoot应用程序时，我们通常需要与数据库进行交互，为了确保我们的应用程序在生产环境中可以正常工作，我们需要进行数据库集成测试，在本文中，我们将介绍如何使用 SpringBoot 中的 EmbeddedDatabaseBuilder 来进行数据库集成测试2023-07-07
这篇文章主要介绍了Java设计模式—观察者模式，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2019-03-03
这篇文章主要为大家详细介绍了如何实现nacos的配置的热更新,文中的示例代码讲解详细,具有一定的借鉴价值,感兴趣的小伙伴可以跟随小编一起学习一下2023-12-12
最新评论