加入收藏 | 设为首页 | 会员中心 | 我要投稿 李大同 (https://www.lidatong.com.cn/)- 科技、建站、经验、云计算、5G、大数据,站长网!
当前位置: 首页 > 编程开发 > asp.Net > 正文

asp.net-web-api2 – Swagger中的数据注释

发布时间:2020-12-15 23:58:00 所属栏目:asp.Net 来源:网络整理
导读:我正在使用ASP.NET和Swagger公开一个接受POST的复杂类型.它有许多具有不同限制长度的字符串字段.我怎样才能在Swagger UI中反映出来? 解决方法 您可以使用System.ComponentModel.DataAnnotations中的StringLengthAttribute注释属性. 例如: [StringLength(10
我正在使用ASP.NET和Swagger公开一个接受POST的复杂类型.它有许多具有不同限制长度的字符串字段.我怎样才能在Swagger UI中反映出来?

解决方法

您可以使用System.ComponentModel.DataAnnotations中的StringLengthAttribute注释属性.

例如:

[StringLength(10)]
public String Name {get;set;}

会变成:

"name": {
    "minLength": 0,"maxLength": 10,"type": "string"
}

和这个:

[StringLength(10,MinimumLength = 5)]
public String Name {get;set;}

变为:

"name": {
    "minLength": 5,"type": "string"
}

除StringLength外,Swashbuckle还支持Range和RegularExpression属性.

更新

MaxLength不起作用. StringLength.但是,在Swagger UI中发现这些信息有点笨拙.您必须导航到对象的模型,然后将鼠标悬停在属性上:

(编辑:李大同)

【声明】本站内容均来自网络,其相关言论仅代表作者个人观点,不代表本站立场。若无意侵犯到您的权利,请及时与联系站长删除相关内容!

    推荐文章
      热点阅读