如何使用 YAML 为 Swagger-API 插入 JSON 代码块？

Question

在我正在使用 YAML 编辑的招摇文档中。我打算使用 GFM 语法插入一个代码块，这是根据this document swagger 所期望的。

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

这一切都以一行结束是因为您通过指定> 使用folded style block scalar（- 用于剥离chomping 指示符）。

您要使用的是literal style block scalar，它会保留换行符和间距。您可能还想使用默认剪辑 chomping（在 JSON 代码末尾留一个换行符）：

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

（唯一的变化是第一行>- 到|）