如何使Swagger在生成的HTML中（在Swagger UI页面中）添加新行？

Question

我有一个REST服务方法，带有注释io.swagger.annotations.ApiOperation

@ApiOperation(value = "some string")

我需要some string才能在HTML页中生成换行符swagger-ui.html（即在Swagger UI页面中，我可以看到我的文档，并且可以测试我的API方法）。我尝试将<br/>和\n放在some string中，我想到的一切，以及我在此处可以找到的建议的任何内容...但是没有任何效果。

有什么想法吗？还是不可能？

我看到该项目使用Swagger 1.5.20 JAR。我无法更改该版本。

swagger-annotations-1.5.20.jarswagger-models-1.5.20.jar

Answer 1

恐怕您不能将换行符放入摘要字段而不是描述字段。查看Swagger团队成员的评论：Swagger UI ignores line breaks in description

summary字段显示为单行，因为摘要文本在<span>元素内。作为嵌入式元素，范围将忽略\n个字符。

此外，由于<br>字段是一个简单的字符串字段，而不是summary，它是一个Markdown字段，因此description没有出现...