Swagger @Example与@ExampleProperty使用无效原因分析
作者：很倔也很天真
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不支持显示
但后端返回数据中有配置的内容
参照没有使用配置的接口可以发现，当他发现有实体的时候就直接使用实体中的描述来显示了。
总结
以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。