Mehrzeilige Literale im Swagger-Editor?

8

Ich versuche, ein mehrzeiliges Literal im Swagger-Editor zu bekommen (übrigens ein tolles Tool!).

%Vor%

Ich habe es mit | versucht und & gt; mit unterschiedlichen Endungen (wachsender Einzug gegen leere Zeile) und jeder denkbaren Art, aber es gibt immer den gleichen Fehler:

%Vor%

Ich sehe Bugs für JS-YAML, die darauf hindeuten, dass das Problem ein Windows-Style-Newline am Ende ist, von dem ich weiß, dass es HTML-Textareas erstellen können. Das ist das erste Mal, dass ich wirklich viel YAML benutze, also mache ich nur etwas falsches oder einen Fehler im Swagger-Editor?

    
fool4jesus 26.01.2015, 23:25
quelle

2 Antworten

17

Ich glaube, das Problem ist, wie Sie den Text in Ihrem Beschreibungsblock gestartet haben. Es muss eine Ebene rechts von der Beschreibung eingerückt werden: Hier ist ein Beispiel für etwas, das für mich funktioniert:

%Vor%

In meinem tatsächlichen Code ist die Beschreibung drei Zeilen lang.

    
Mike Malloy 27.01.2015, 16:32
quelle
2

Wollte den JSON-Ansatz hinzufügen. Ich verwende reines JSON im Swagger-Editor, um Probleme mit doppelter Syntax zu vermeiden (Lernen, Debuggen, Parsen für Web-Dokumentation , etc.).

%Vor%

Aus irgendeinem Grund schien das doppelte Zeilenumbruchzeichen \n erforderlich zu sein, zumindest für die neue Zeile, die im Swagger Editor gerendert werden sollte. Wenn ich jedoch die offizielle Uber API YAML Demo als JSON (Datei - & gt; Download als JSON) exportiert habe, hatte der resultierende JSON nur einzelne Newline-Zeichen, in denen Multi-Line-Literale demonstriert wurden. Seltsam.

    
straville 02.12.2016 08:24
quelle