为swagger输出添加换行符

时间:2018-01-31 07:41:08

标签: java jersey jax-rs swagger

我正在使用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>" 
 )})

通过使用它,我能够向&#34; Hello World&#34;添加描述。头。我的问题是我应该如何为每一点添加换行符。我尝试了以下但失败了:

  1. "\n""<br>"添加到字符串中。 \n"并不能反映出来 换行符"<br>"只是将字符串"<br>"添加到字符串中 这是渲染。

  2. 我尝试使用System.lineSeparator()System.getProperty("line.separator")同样可以提供 错误&#34;注释属性Tag.description的值必须是a 不断表达&#34;。

  3. 当使用notes参数进行其他注释(不使用@Api)时,使用上述第一种方法时,Swagger会显示换行符,是否有使用该方法来获取换行符?

    欢迎任何建议,谢谢! :)

2 个答案:

答案 0 :(得分:1)

您可以使用以下内容:

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

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

enter image description here

玩得开心!

答案 1 :(得分:0)

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

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