向 swagger 输出添加换行符

Question

我正在使用

swagger-jersey2-jaxrs

版本

1.5.15

。我在

swagger-ui 3.0.9

。我使用 @SwaggerDefinition 注释和标签向标头添加了描述（因为描述参数现已弃用）。代码如下：

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

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

1. 将

   "\n"

   或

   "<br>"

   添加到字符串中。

   \n"

   不反映 换行符而

   "<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>" 
 )})

Answer 2

您可以使用以下内容：

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

它对我有用，它给出以下结果，并带有换行符：

玩得开心！

Answer 3

只需添加

<br><br>

示例：

  /autoComplete:
    post:
      tags:
        - AutoComplete Service
      summary: Various AutoComplete Services 
      description: > List 
        1. Name <br><br>
        2. Teams  <br><br>