java - 在 swagger 输出中添加换行符

Question

我正在使用swagger-jersey2-jaxrs版本1.5.15 。我在swagger-ui 3.0.9 。我使用 @SwaggerDefinition 注释和标签向 header 添加了描述(因为描述参数现已弃用)。代码如下:

@Api(tags = { "Hello World" })
@SwaggerDefinition(tags = { @Tag(name = "Hello World", description = 
    "Description about world: " + "  \n" +
    "1. Hello " + "\n" +
    "2. World " + "<br>" 
 )})

通过使用它，我能够向“Hello World” header 添加描述。我的问题是如何为每个点添加换行符。我尝试了以下方法但失败了:

1. 添加"\n"或"<br>"串起来。 \n"不反射(reflect)换行符而 "<br>"只需添加字符串 "<br>"到字符串已渲染。

2. 我尝试使用System.lineSeparator()和 System.getProperty("line.separator")也是如此，但这给出了错误“注释属性 Tag.description 的值必须是常量表达式”。

当使用notes时使用上述第一种方法时，Swagger会显示换行符其他注释的参数(不适用于@Api)，有什么解决方法可以使用它来获取换行符吗？

欢迎任何建议，先谢谢了! :)

Answer 1

使用双“<br>”或“\n”，swagger将在下一行显示文本。例如:

@SwaggerDefinition(tags = { @Tag(name = "Hello World", description =
"Description about world: \n\n" +
"1. Hello \n\n" +
"2. World <br><br>"
)})