Swagger注释@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字符。

此外，您的
没有显示出来，因为summary字段是一个简单的字符串字段，而description是一个标记字段：

摘要：一个可选的字符串摘要，旨在应用于此路径中的所有操作。

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

标记字段允许HTML（尽管我们在Swagger-UI中去掉了大多数HTML标记，以防止XSS攻击），但常规字符串字段不允许，它们只是按原样显示。

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

另外，我在description字段中测试了您的示例字符串，它按照我的预期工作（在
和\n上断行）。

希望这能帮上忙！