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

Question

我正在使用 ASP.NET 和 Swagger，它们公开了一个接受 POST 的复杂类型。它有许多具有不同限制长度的字符串字段。如何在 Swagger UI 中反射(reflect)这一点？

Answer 1

您可以使用 StringLengthAttribute 对属性进行注释。来自 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"
}

除了 StringLength Swashbuckle 还支持 Range和 RegularExpression属性。

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