Swagger

Question

'daki veri ek açıklamaları ASP.NET ve Swagger kullanarak bir POST kabul eden karmaşık bir tür açığa çıkarıyorum. Farklı kısıtlı uzunluklara sahip bir dizi dize alanı vardır. Bunu Swagger UI'de nasıl yansıtabilirim?

Answer 1

System.ComponentModel.DataAnnotations'dan StringLengthAttribute ile ilgili özelliklere açıklama ekleyebilirsiniz. Örneğin

:

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

Ve bu:

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

olacak

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

olur:

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

StringLength Swashbuckle ayrıca Range ve RegularExpression özniteliklerini de destekler.

Güncelleme

MaxLength çalışmaz. StringLength yapar. Ancak, bu bilgiyi Swagger UI'de keşfetmek biraz beceriksizdir.