大摇大摆编辑器中的多行文字



我正在尝试在 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文本区域可以创建。这是我第一次真正使用YAML太多,所以只是我做错了什么,还是Swagger编辑器中的错误?

我相信问题在于您在描述块上开始文本的方式。 它必须在描述右侧缩进一级: 这是一个对我有用的示例:

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

在我的实际代码中,描述有三行长。

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

  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.

想要添加 JSON 方法。我在 Swagger 编辑器中使用纯 JSON 以避免双重语法问题(学习、调试、解析 Web 文档等)。

"get": {
    "description": "HinnThere",

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

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

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

就我而言,复制/粘贴一些在文本前面有制表符的文本使其"看起来"不错,但导致了此错误

相关内容

  • 没有找到相关文章

最新更新