Annotazioni dei dati in Swagger

Question

Sto usando ASP.NET e Swagger che espone un tipo complesso che accetta un POST. Ha un numero di campi stringa con lunghezze diverse. Come posso rifletterlo nell'interfaccia utente di Swagger?

Answer 1

È possibile annotare le proprietà con StringLengthAttribute da System.ComponentModel.DataAnnotations.

Per esempio:

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

diventerà:

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

E questo:

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

diventa:

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

Oltre allo StringLength, lo Swashbuckle supporta anche gli attributi Range e RegularExpression.

Aggiornamento

MaxLength non funziona. StringLength fa. Tuttavia, scoprire queste informazioni nell'interfaccia utente di Swagger è un po 'goffo. Bisogna passare alla Model del vostro oggetto e poi il mouse sopra la proprietà: