Wie fügt man einen JSON Code Block für eine Swagger-API mit YAML ein?

Question

In meinem protzigen Dokument, das ich mit YAML bearbeite. Ich wollte einen Code-Block unter Verwendung der GFM-Syntax einfügen, was Swagger gemäß this document erwartet.

description: >- 
    Some description of the object here. 
    More Here. An example to for this is as follows: 
    ```json 
    { 
    "Key": { 
     "name": "myName", 
     "id": 100 
    } 
    } 
    ``` 

Dies ist jedoch nicht zeigen, nicht als JSON-formatiert, sondern es endet alles auf eine Zeile wie diese sind up:

Some description of the object here. More Here. An example to for this is as follows: ```json { "Key": { "name": "myName", "id": 100 } } ``` 

Answer 1

Das alles endet als eine Zeile ist, weil Sie verwenden a folded style block scalar unter Angabe von > (- ist zum Abziehen von Chopping-Indikator).

Was Sie verwenden möchten, ist ein literal style block scalar, mit dem die Zeilenumbrüche und Abstände beibehalten wird. Sie wollen wahrscheinlich auch den Standard-Clip verwenden scharren (ein Newline am Ende des JSON-Code zu verlassen):

description: | 
    Some description of the object here. 
    More Here. An example to for this is as follows: 
    ```json 
    { 
    "Key": { 
     "name": "myName", 
     "id": 100 
    } 
    } 
    ``` 

(die einzige Änderung in der ersten Zeile ist >- zu |)