Daten Annotationen in Swagger

Question

Ich benutze ASP.NET und Swagger, die einen komplexen Typ, der einen POST akzeptiert. Es verfügt über mehrere Zeichenfolgenfelder mit unterschiedlichen eingeschränkten Längen. Wie kann ich das in der Swagger UI widerspiegeln?

Answer 1

Sie können die Eigenschaften mit der StringLengthAttribute von System.ComponentModel.DataAnnotations annotieren.

Zum Beispiel:

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

wird geworden:

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

Und:

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

wird:

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

Neben StringLength unterstützt Swashbuckle auch die Attribute Range und RegularExpression.

aktualisieren

MaxLength funktioniert nicht. StringLength tut. Diese Informationen in der Swagger-Benutzeroberfläche zu finden, ist jedoch etwas ungeschickt. Sie müssen die Model Ihr Objekt navigieren und dann über das Objekt schweben: