招摇编辑器中的多行文字？

Posted 2023-02-26

【中文标题】招摇编辑器中的多行文字？

【英文标题】：Multi-line literals in swagger editor?

【发布时间】：2015-03-25 11:41:48

【问题描述】：

我正在尝试在 Swagger 编辑器中获取多行文字（顺便说一句，很棒的工具！）。

  post:
    summary: Translate one or more identifiers
    description: |
Translate one or more identifiers for one entity into the
identifiers of another entity. Translate one or more
identifiers for one entity into the identifiers of another entity.

    consumes:
    - application/json

我试过 |和 >，具有不同的结尾（增加缩进与空行），以及我能想到的各种方式，但它总是给出相同的错误：

YAML Syntax Error
Can not read a block mapping entry; a multiline key may not be an implicit  
key at line 24, column 15: consumes: ^

我看到 JS-YAML 的错误表明问题是最后的 Windows 样式换行符，我知道 html textareas 可以创建它。这是我第一次真正大量使用 YAML，是我做错了什么，还是 Swagger 编辑器中的错误？

【问题讨论】：

我发现很难在在线 Swagger 编辑器中调试这样的语法错误。这些问题在 SublimeText 等文本编辑器中更容易识别，其中颜色编码用于突出语法问题。

我可以看到@OneXer。我想这些事情比我问这个问题时要发达得多。今天我可能会使用 VSC。

【参考方案1】：

就我而言，它只是一个 /，我应该将它放在永久链接的开头，在我的 category.md 中：

permalink: / blog.catPermalinkPrefix / category.slug / 

【参考方案2】：

这是缩进。应该是这样的：

  post:
    summary: Translate one or more identifiers
    description: |
      Translate one or more identifiers for one entity into the
      identifiers of another entity. Translate one or more
      identifiers for one entity into the identifiers of another entity.

【参考方案3】：

想要添加 JSON 方法。我在 Swagger 编辑器中使用纯 JSON 以避免双重语法问题（学习、调试、解析 web documentation 等）。

"get": 
    "description": "Hi\n\nThere",

由于某种原因，似乎需要双换行符\n，至少要在 Swagger 编辑器上呈现新行。但是，当我将官方 Uber API YAML demo 导出为 JSON（文件 -> 下载为 JSON）时，生成的 JSON 只有单个换行符，其中演示了多行文字。很奇怪。

【参考方案4】：

我认为问题在于您在描述块上开始文本的方式。它必须在描述右侧缩进一级：这是一个适合我的示例：

/user-id:
get:
  summary: Facebook User
  description: |
    Displays all information about a Facebook user, depending on access privileges.  Displays all information about a Facebook user, depending on access privileges.
  parameters:
    - name: user-id
      in: path
      description: The Facebook user ID
      required: true
      type: string

在我的实际代码中，描述是三行。

【讨论】：

好节目...谢谢！这个细节在 YAML 规范中根本不清楚。

在我的情况下，同样的错误信息是由于在上一行（摘要）的冒号后缺少一个空格引起的，但你的回答让我看得更仔细。