Datum Zeit null Modellschema Anzeige swashbuckle + swagger UI

Question

Ich habe Swashbuckle und Swagger UI implementiert, um meine API-Dokumentation zu tun.

Ich habe ein Problem mit der Anzeige eines Nullable DateTime, oder irgendein Nullable-Objekt für diese Angelegenheit.

Derzeit wird im Antwortmodellschema DateTime als "date": "2016-05-27T00:15:41.658Z" als Nullwert angezeigt.

Das Antwortmodell zeigt das Datum als date (string, optional) an, in dem angegeben ist, dass es optional ist. Es wird jedoch auch für ein nicht nullbares DateTime angezeigt.

Ich habe versucht, den Standardwert hinzuzufügen: Default model example in Swashbuckle (Swagger) und auch versucht, ein Modellschema Beispiel über die letzte Antwort hinzuzufügen.

Irgendwelche Ideen, wie ich "date": "null" im Modellschema anzeigen lassen kann? Oder alternativ einen besseren Weg finden, der Person, die die Dokumentation liest, einen Hinweis zu geben, dass das Objekt date null sein kann?

Answer 1

Die kurze Antwort

Sie können nicht und Sie sollten nicht länger

Die leicht beantworten

Grundsätzlich ist die Dokumentation, date (string, optional), ist bereits Ihre Verbraucher zu sagen, dass die Die Eigenschaft kann in einer Anfrage oder Antwort null sein oder fehlen. Ein Beispiel mit "date": null ist nicht sehr hilfreich. Die Bereitstellung eines Beispiels mit einem gültigen Datum ist jedoch hilfreich: Es gibt dem Verbraucher eine Vorstellung davon, wie das Datum aussieht.

Jetzt, auf die DateTime und DateTime? Eigenschaften Server-Seite. Wenn der Server ein Objekt mit einem fehlenden Datum empfängt, bestimmt der Typ der Eigenschaft den Wert. Wenn eine Eigenschaft mit dem Typ DateTime fehlt, wird ASP.Net Web API diese Eigenschaft auf das minimale Datum (01-01-0001Z00: 00: 00) festlegen. Wenn jedoch eine Eigenschaft mit dem Typ DateTime? fehlt, wird die ASP.Net-Web-API diese Eigenschaft auf null setzen.

Das gleiche gilt für die Antwort vom Server gesendet. Wenn der Server ein Objekt mit einer Eigenschaft des Typs DateTime sendet, wird immer ein Wert gesendet. Wenn jedoch eine Eigenschaft mit dem Typ DateTime? gesendet wird, hat die Eigenschaft sent nur einen Wert, wenn `HasValue 'der Eigenschaft wahr ist. Andernfalls hat die Antwort nicht die Eigenschaft.