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

Posted 2023-02-26

【中文标题】如何让 Swagger 在生成的 HTML（在 Swagger UI 页面中）中添加新行？

【英文标题】：How to make Swagger put new line in the generated HTML (in Swagger UI page)?

【发布时间】：2020-08-31 14:07:01

【问题描述】：

我有一个带有注释的 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

【参考方案1】：

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

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

此外，您的<br> 没有显示，因为summary 字段是一个简单的字符串字段，而description 是一个 Markdown 字段...

【讨论】：

谢谢。那我该如何控制这个描述字段呢？我应该使用另一个注释而不是@ApiOperation吗？

我想我找到了，它是@ApiOperation 的notes 属性。