在swagger输出中添加一个换行符

l0oc07j2 于 9个月前发布在其他

关注(0)|答案(3)|浏览(271)

我使用的是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"或" "添加到字符串。\n"不反映换行符，而" "只是将字符串" "添加到呈现的字符串中。
1.我也尝试使用System.lineSeparator()和System.getProperty("line.separator")，但这给出了错误“The value for annotation attribute Tag.description must be a constant expression”。
当使用上述第一个方法时，Swagger会显示一个换行符，当使用notes参数作为其他注解时（不适用于@API），有什么变通方法可以使用它来获取换行符吗？
任何建议都欢迎，提前感谢！：）

swagger

来源：https://stackoverflow.com/questions/48536934/add-a-newline-to-swagger-output

3条答案

按热度按时间

sbtkgmzw1#

使用双“ “或“\n“，swagger将显示下一行的文本。例如：
@SwaggerDefinition(tags = { @Tag(name = "Hello World", description = "Description about world: \n\n" + "1. Hello \n\n" + "2. World " )})

赞(0）回复(0）举报 9个月前

xj3cbfub2#

您可以使用以下内容：

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

它为我工作，它给出了以下结果，带有换行符：

玩得开心点！

赞(0）回复(0）举报 9个月前

x0fgdtte3#

只需添加

<br><br>

举例说明：

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

赞(0）回复(0）举报 8个月前

我来回答

在swagger输出中添加一个换行符

3条答案

相关问题

热门标签

最新问答