Swagger Beispiel Post Body von Anmerkungen

Weiß jemand, ob es möglich ist, einen Beispiel-Post-Body mit vorgefüllten/Standardwerten aus Java-Annotationen zu erstellen? Mein Ziel ist, dass Benutzer ein funktionierendes Beispiel haben, wenn sie einen POST-Endpunkt in Swagger UI anzeigen. Im Idealfall wird dieses Arbeitsbeispiel aus Anmerkungen im Code erstellt.Swagger Beispiel Post Body von Anmerkungen

zum Beispiel auf einer Modell Objekteigenschaft:

@ApiModelProperty(example = "http://istock.com/my_cool_image") 
    @JsonProperty("submitted-image-url") 
    private String submittedImageUrl;

so etwas wie dies in Swagger UI erzeugen würde (man beachte die Beispiel-URL zeigt im Modell-Schema oben):

Quelle

2016-05-17 Fabian

Haben Sie das im Code versucht? Genau so funktioniert es. Das Eingabemodell wird 'Beispielwerte' für den Schein verwenden. – fehguy

@fehguy Ja, ich habe fast diesen genauen Code ausprobiert. Es scheint immer, den Wert von submitted-image-url auf "string" aufzufüllen und nicht auf den Wert, den ich als Beispiel in der obigen ApiModelProperty-Annotation angegeben habe. – Fabian

Des So wie es aussieht, müssen Sie unter Datentyp auf Beispielwert klicken, damit das Textfeld Anfrage/Wert ausgefüllt wird (zumindest in Swagger 1.5.9).

Quelle

2016-08-04 19:19:14 KirEvse

Swagger Beispiel Post Body von Anmerkungen

Antwort

Verwandte Themen