如何在YAML中转义尖括号？

Question

美洲国家组织：

openapi: 3.0.0
info:
  title: User Management API
  version: 1.0.0
servers:
  - url: http://localhost:8080/api
paths:

  /users:
    get:
      summary: "Find all existing users"
      operationId: findAll
      responses:
        '200':
          description: "Users found. Response: List<User>"
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'
    ...

检查 SwaggerUI，我注意到描述只是

用户发现。回复：列表

该在什么时候

用户发现。回复：列表

如何摆脱尖括号？

Answer 1

OpenAPI 允许在

description

字段中使用 Markdown。

Markdown 允许内联 HTML 标记（至少某些 Markdown 变体可以，并且此处处理文本的标记可以）。

<User>

看起来 就像内联 HTML 标签。

因此，在显示描述时，它不会呈现为文本，而是会被忽略，因为它是无效的 HTML 标记。

解决办法是写

List<User>

。