Das Swagger-Modell für ein JSON-Array zu schreiben erscheint mir ziemlich einfach, z.B. wenn ich dieses Array hätte:
%Vor%Ich würde das folgende Swagger-Modell dafür schreiben:
%Vor%Allerdings habe ich Folgendes:
%Vor%Wie schreibe ich das Modell für dieses?
Vielen Dank im Voraus.
Um das Anforderungsmodell zu beschreiben, müssen Sie die Eigenschaften additionalProperties verwenden. Wohlgemerkt, dies ist in Swagger 2.0 verfügbar und war in früheren Versionen nicht verfügbar.
Oben sehen Sie das Student -Modell, das momentan die "name" -Eigenschaft enthält, obwohl ich davon ausgehe, dass Sie mehr hinzufügen werden. In Ihrem obigen Beispiel ist die Eigenschaft "name" erforderlich.
Das zweite Modell ist Students . Dies ist ein Objekt, das eine Zuordnung (additionalProperties) enthält. Jede Eigenschaft hat den Typ Student (erfolgt durch Referenzieren des Modells, könnte theoretisch aber auch inline definiert werden).
Die einzige Sache, die Sie nicht tun können, ist zu deklarieren, dass der Schlüssel (oder der Name der Eigenschaft) eine Ganzzahl oder einen gegebenen Typ ist. Das hätte mit der patternedProperties unterstützt werden können, die in Swagger 2.0 nicht verfügbar ist. Mit anderen Worten, es gibt keine technische Möglichkeit, den Inhalt des Schlüssels zu beschränken.
Tags und Links swagger