Swagger Annotations @Schema 更大的描述

Question

我有一个描述更大的字段。

@Schema(description = "Lorem ipsum dolor sit amet\n consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua\n Ut enim ad minim veniam\n quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat")
@StringField(required = false)
private String myField;

在 swagger-ui 页面中，描述是内联的。在记录模型时有什么方法可以使“\n”工作吗？

Answer 1

摘要字段显示为单行，因为摘要文本位于元素内部。作为内联元素，span 会忽略 \n 个字符。

此外，您的
没有显示，因为摘要字段是一个简单的字符串字段，与描述相反，描述是一个 Markdown 字段：

summary: An optional, string summary, intended to apply to all operations in this path.

description：一个可选的字符串描述，旨在应用于此路径中的所有操作。 CommonMark 语法可以用于富文本表示。

Markdown fields allow HTML (though we strip most HTML tags out in Swagger-UI, for protection against XSS attacks), but regular string fields do not, they're just displayed as-is.

在 Swagger-UI 中，我们希望您的摘要只有一行，因为它被添加到 OpenAPI 规范中，目的是成为操作描述的较短版本。允许多行摘要需要我们重新编写摘要和操作 UI，而 IMO 将违背摘要和描述字段的精神。

希望这对您有所帮助！

Swagger Annotations @Schema 更大的描述

Swagger Annotations @Schema larger description

java

spring

swagger-ui