Yaml“示例：”中的文本格式答案

【问题标题】：Text formatting in Yaml "example:"Yaml“示例：”中的文本格式
【发布时间】：2018-05-16 15:19:26
【问题描述】：

我正在尝试在 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 更新 Helen 关于她的解决方案的屏幕截图请求：

这是我通过使用“示例：”从两种解决方案中得到的：

这是我通过使用“示例：”得到的：

两者总是空的。

【问题讨论】：

标签： yaml swagger swagger-ui

【解决方案1】：

YAML 是 JSON 的超集，因此您可以在 YAML 中使用普通的 JSON 对象字面量语法：

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

或者，您可以使用 YAML 对象语法，Swagger UI 会将示例呈现为 JSON（前提是您的请求或响应类型为 JSON）：

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

【讨论】：

嗨！是的，请求类型是 JSON。我尝试了这两个选项，现在我得到了：log_level_per_component": {} 缺少什么？ :-O
@neo 您在哪里看到该结果 - 在 Swagger 编辑器、Swagger UI 等中？可以发个截图吗？
@neo 在最新的 Swagger UI/编辑器中对我来说很好用：i.stack.imgur.com/DxCUf.png。请确保缩进正确。将您的规范粘贴到 editor.swagger.io 以检查语法错误。如果它仍然不起作用，请编辑您的问题并发布完整的规范。
你是对的，在 editor.swagger.io 中它工作正常。我现在看到我们从 YAML 文件到一个全局 Swagger 文件的转换器正在删除它。在 YAML 中：example: { "Component1": "Info", "Component2": "Debug", "Component3": "Error" } 在 Swagger 文件中：example: "" 我会检查原因并告诉你。