Форматирование текста в Yaml "пример:" - PullRequest
Новая
       12

Форматирование текста в Yaml "пример:"

0 голосов
/ 16 мая 2018

Я пытаюсь отобразить некоторый форматированный текст в файле YAML (с помощью клавиши example:): 

  log_level_per_component:
     type: object
     example:
       "{
        \"Component1\": \"Info\",\n
        \"Component2\": \"Debug\",\n
        \"Component3\": \"Fatal\",\n
        ...\n
        }"

для получения такого вывода Swagger: 

"log_level_per_component": "{
                            "Component1": "Info",n
                            "Component2": "Debug",n
                            "Component3": "Fatal",n
                            ...
                            }"

но я всегда получаю это: 

"log_level_per_component": "{ \"Component1\": \"Info\",\n \"Component2\": 
\"Debug\",\n \"Component3\": \"Fatal\",\n ...\n }"

Есть идеи, что я могу сделать, чтобы это исправить?

Обновление 2018-05-17 для запроса скриншота Хелен о ее решении:

Это то, что я получаю с обоими решениями, используя "пример:":

И это то, что я получаюиспользуя "examples:":

Оба они всегда пусты.

1 Ответ

0 голосов
/ 16 мая 2018

YAML - это расширенный набор JSON, поэтому вы можете использовать обычный синтаксис литералов объекта JSON в YAML: 

  log_level_per_component:
    type: object
    example:
      {
       "Component1": "Info",
       "Component2": "Debug",
       "Component3": "Fatal"
      }

В качестве альтернативы, вы можете использовать синтаксис объекта YAML, и пользовательский интерфейс Swagger отобразит пример как JSON (при условии, что тип вашего запроса или ответа - JSON): 

  log_level_per_component:
    type: object
    example:
      Component1: Info
      Component2: Debug
      Component3: Fatal
...