Swagger中的数据注释

Question

我使用ASP.NET和Swagger公开了一个接受POST的复杂类型.它有许多具有不同限制长度的字符串字段.我怎样才能在Swagger UI中反映出来？

Answer 1

您可以使用StringLengthAttributefrom 注释属性System.ComponentModel.DataAnnotations.

例如:

[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,
    "maxLength": 10,
    "type": "string"
}

除了StringLengthSwashbuckle还支持Range和RegularExpression属性.

更新

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