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

Question

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

@ApiOperation(value = "some string")

我需要some string在 HTML 页面 swagger-ui.html 中生成换行符
（即在 Swagger UI 页面中我看到我的文档并且我可以测试我的 API 方法）。
我尝试将<br/>and\n以及some string任何我能想到的
东西，以及我能在 SO 上找到的任何东西作为建议......但没有任何效果。

有任何想法吗？还是只是不可能？

我看到该项目使用 Swagger 1.5.20 JAR。
那个版本我改不了。

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

标签： javaspring-bootrestswaggerswagger-ui

Answer 1

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

该summary字段显示为单行，因为摘要文本位于<span>元素内部。作为一个内联元素，span 会忽略\n字符。

此外，您<br>没有出现，因为该summary字段是一个简单的字符串字段，而不是descriptionMarkdown 字段...