首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >在swagger输出中添加新行

问在swagger输出中添加新行
EN

Stack Overflow用户
提问于 2018-01-31 07:41:08
回答 2查看 33K关注 0票数 10

我正在使用swagger-jersey2-jaxrs版本的1.5.15。我在swagger-ui 3.0.9上。我使用@SwaggerDefinition注释和标记(因为现在不再推荐description参数)将描述添加到头中。代码如下:

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

通过使用它,我能够向"Hello“标题添加一个描述。我的问题是,我应该如何为每一点添加一个换行符。我尝试了以下几种方法,但失败了:

  1. 将"\n"或"<br>"添加到字符串中。\n"不反映换行符,而"<br>"只是将字符串"<br>"添加到呈现的字符串中。
  2. 我也尝试使用System.lineSeparator()和System.getProperty("line.separator"),但是这给了错误“注释属性Tag.description的值必须是一个常量表达式”。

Swagger在对其他注释使用notes参数(不适用于@Api)时使用上面的第一个方法时会显示换行符,是否可以使用它来获得换行符呢?

欢迎任何建议,谢谢!)

EN

回答 2

Stack Overflow用户

发布于 2019-11-14 01:38:05

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

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

票数 16
EN

Stack Overflow用户

发布于 2018-02-02 16:36:01

您可以使用以下内容:

代码语言:javascript
复制
@SwaggerDefinition(tags = { @Tag(name = "Hello World", description =
    "Description about world: <br /> " +
            "1. Hello <br /> " +                  //With <br />, not  <br>
            "2. World ")})   

它对我有用,它给出了以下结果,并给出了换行符:

​

​

玩得开心!

票数 12
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/48536934

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档