如何在YAML中转义尖括号？解决SwaggerUI显示异常问题

云上老周

2026-6-26

解决OpenAPI描述中尖括号显示不全的问题

在Swagger UI里，<>会被当作HTML标签解析，导致你写的List<User>只显示List部分。可以通过以下几种方式解决：

方法一：用单引号包裹描述字符串
YAML的双引号会自动解析转义字符，把<转成<，进而被Swagger UI当作HTML标签隐藏。改用单引号包裹后，YAML不会提前解析转义实体，能完整传递给Swagger UI并正确显示：
```
responses:
  '200':
    description: 'Users found. Response: List&lt;User&gt;'
```
方法二：用Markdown代码格式包裹类型
把需要显示的类型用反引号包裹，Swagger UI会将其识别为代码文本，完整保留尖括号：
```
responses:
  '200':
    description: "Users found. Response: `List<User>`"
```
方法三：直接使用原始尖括号并包裹单引号
如果不需要转义实体，直接写List<User>并用单引号包裹字符串，避免YAML语法报错的同时，让Swagger UI正常显示内容：
```
responses:
  '200':
    description: 'Users found. Response: List<User>'
```