我要评论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不支持显示
但后端返回数据中有配置的内容
参照没有使用配置的接口可以发现，当他发现有实体的时候就直接使用实体中的描述来显示了。
总结
以上为个人经验，希望能给大家一个参考，也希望大家多多支持代码网。
发表评论