【发布时间】:2018-01-31 07:41:08
【问题描述】:
我正在使用swagger-jersey2-jaxrs 版本1.5.15。我在swagger-ui 3.0.9。我使用 @SwaggerDefinition 注释和标签向标题添加了描述(因为现在不推荐使用 description 参数)。代码如下:
@Api(tags = { "Hello World" })
@SwaggerDefinition(tags = { @Tag(name = "Hello World", description =
"Description about world: " + " \n" +
"1. Hello " + "\n" +
"2. World " + "<br>"
)})
通过使用它,我能够向“Hello World”标题添加描述。我的问题是我应该如何为每个点添加一个换行符。我尝试了以下方法但失败了:
将
"\n"或"<br>"添加到字符串。\n"不反映 换行,而"<br>"只是将字符串"<br>"添加到字符串中 即被渲染。我尝试使用
System.lineSeparator()和System.getProperty("line.separator")也是如此,但这给出了 错误“注释属性 Tag.description 的值必须是 常量表达式”。
当使用notes 参数用于其他注释(不适用于@Api)时,使用上述第一种方法时,Swagger 会显示换行符,是否有任何解决方法可以使用它来获取换行符?
欢迎任何建议,在此先感谢! :)
【问题讨论】:
-
这只是一个猜测,但您是否尝试过“\\n”?
-
@Daniel 是的,刚刚尝试过。在呈现的字符串中添加一个 '\n' :/
-
下一次尝试:使用“\n\n”。两段之间需要一个空行。看看:github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#lines
-
谢谢@Daniel,但还是不行。
-
尝试缩小/缩小范围,例如:
&lt;br /&gt;
标签: java jersey jax-rs swagger