Как вставить код JSON для Swagger-API с помощью YAML?

Question

В моем документе, который я редактирую, используя YAML. Я намеревался вставить блок кода с использованием синтаксиса GFM, который ожидает от него в соответствии с this document.

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

Это, однако, не отображается отформатированный как JSON, а все это заканчивается тем, что на одной линии, как это:

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

Answer 1

Это все заканчивается, как одна линия, потому что вы используете a folded style block scalar, указав > (- для зачистки индикатора горения).

То, что вы хотите использовать, это literal style block scalar, при этом разрывы строк и интервалы сохраняются. Возможно, вы также хотите использовать клип по умолчанию чавканье (оставляя одну строку в конце кода JSON):

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

(единственное изменение на первой линии >- к |)