swagger 编辑器中的多行文字？

Question

我正在尝试在 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 编辑器中的错误？

Answer 1

我认为问题在于您在描述栏中开始文本的方式。它必须在描述的右侧缩进一级：这是一个对我有用的例子：

/{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

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

Answer 2

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

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

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

Answer 3

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

  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.

Answer 4

在我的例子中，它只是一个 /，我应该放在永久链接的开头，在我的 category.md:

permalink: /{{ blog.catPermalinkPrefix }}/{{ category.slug }}/

swagger 编辑器中的多行文字？

Multi-line literals in swagger editor?

yaml

indentation

swagger

swagger-editor