在 springfox-swagger-ui 中渲染 html

2024-06-28

我最近更新了运行 springfox-swagger2 和 springfox-swagger-ui 2.5.0 的应用程序以使用版本 2.6.0。应用程序的API文档使用<li>, <b> and <br>标签,在 2.5.0 中可以正确呈现,但在 2.6.0 版本中<li> and <br>swagger-ui 会忽略标签。

我需要做什么才能让 springfox 再次渲染 HTML 标签?

标签用于以下位置:

ApiInfoBuilder().description("HERE")

@ApiOperation(notes="HERE")
@ApiResponse(message="HERE")

尝试后@ApiOperation注解我发现在2.7.0版本中SpringFox支持Markdown https://guides.github.com/features/mastering-markdown/文本格式的语法(就像 Stack Overflow、GitHub、Atlassian 等)。请参阅任何 Markdown 语法指南以供参考。

我的实验表明,这个 Swagger 注释和下面的 YAML 定义应该是等效的。

@ApiOperation(value = "Markdown in Swagger API descriptions",
    notes = "#Head 1 \n## Head 2 \n###Sorting rules\nThe data is sorted by priority (from the highest to the lowest).<br/> Unordered list \n * item 1.\n * <b>bold item 2</b>\n")

=

summary: Markdown in Swagger API descriptions
description: <h1>Head 1</h1><h2>Head 2</h2><h3>Sorting rules</h3>
             The data is sorted by priority (from the highest to the lowest).<br/> Unordered list
             <ul><li>item 1.</li><li><b>bold item 2</b></li></ul>

并且注释在 Swagger-UI 中生成此输出

我需要做什么才能让 SpringFox 再次渲染 HTML 标签?

您必须将 API 描述翻译为 Markdown。

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

在 springfox-swagger-ui 中渲染 html 的相关文章

  • 如何在 Perl CGI 程序中进行分页和排序?

    这是我从 SQLite 数据库检索数据的表 它有很多记录 所以在 添加 按钮附近我需要类似的东西 lt lt gt gt 每当我点击时 它就会执行分页功能 另外 除了表每个标头 例如 UserName UserId 之外 我还需要排序 按钮
  • 如何在CSS中水平对齐div

    我在一个容器内有三个子 div 我想水平对齐这些 div 我尝试使用CSSfloat财产 但圆圈正在变成椭圆形 标记代码 div class container info box clearfix div class circle div
  • Javascript CORS 图像/画布操作

    我正在尝试从另一个已配置为允许 CORS 的域检索图像 并操纵像素 然后我想显示结果并能够操纵结果 我可以在我请求的图像上使用 getImageData 和 toDataURL 所以我知道服务器部分可以工作 但是 当我尝试将图像的 src
  • CSS @import 及其顺序

    是否可以使用 importone像这样的 css 文件 import file1 some css here import file2 chrome 无法识别上述第二个导入 但这可以工作 import file1 import file2
  • 设置三个输入数字的最大值

    我有三个输入数字
  • 在 Bootstrap 选择器上使用 jQuery 取消选择选项

    我对一些 UI 元素使用 Bootstrap SelectPicker 它允许用户选择多个选项并将其呈现在段落标签中的屏幕上 他们还应该能够删除选定的选项 这是我的代码 用于将选定的选项渲染到屏幕上 以便每个选项旁边都会显示一个 X 单击它
  • 如何使用 GWT 创建可点击的链接?

    我想与 GWT 建立一些可点击的链接 我不确定这是否是最佳实践 基本上我想要类似这样的东西 如果我用 html 编写的话 a href index html alt Link a Use a 超级链接 http google web too
  • 单击即可切换背景颜色和过渡

    这看起来应该很容易 但我真的找不到办法做到这一点 动画 http doir ir css gif http doir ir css gif 当您单击这些相应的链接时 我需要更改和过渡页面的背景颜色 我见过的最接近触发这种类型转换的事情是 仅
  • 如何在流体宽度表中使用省略号而不使每列大小相同?

    假设我的表中的列是id name description and phone The description列的长度为 1 255 个字符 但 id 最多只有 3 个字符 我希望列的大小适当 而不是每列的大小相同 我想要descriptio
  • 带有蓝图 css 的 HTML5 样板

    我正在考虑将这两种技术结合起来用于一个新项目 这是坏主意吗 有没有推荐的替代网格系统与 html5 样板一起使用 实际上 我将它们混合在一起并且它们一起工作得很好 http shikiryu com html5 我所要做的就是修改 div
  • 我如何在ajax应用程序中找到未使用的css?

    我一直在搜索 但找不到任何 ff 插件或 javascript 来查找 ajax 应用程序中未使用的 css 除尘选择器 http www sitepoint com dustmeselectors 可以进行网站抓取 但我正在寻找检查加载内
  • 可以在 iPad 上自动播放 HTML5 视频吗?

    The
  • CSS 粘性位置在移动设备上无法正常工作

    我的 OpenCart 2 3 0 2 网站上有一个带有粘性购物车按钮的按钮 这个想法是只有一个页面可以订购 只有几个三明治 不需要类别和产品页面 所以我添加了一个位于页面右上角的购物车按钮 cart position fixed top
  • 不显示 ul 中的项目符号 [重复]

    这个问题在这里已经有答案了 我在 ul 中显示项目符号时遇到问题 有谁知道问题出在哪里 my site http www minikoblizky wz cz zamestnanci html它以 Co od v s o ek v me 开
  • 重复背景图像被切断

    我有一个容器 DIV 它随着内容的高度而缩放 它有一个背景图像 可以重复向下形成图案 问题是重复的背景图像在 div 底部被切断 有没有办法让背景图像不被切断 这是代码 http jsfiddle net WkEKD 7 http jsfi
  • html 标题的最大长度

    有谁知道我可以为 html title 属性输入的最大长度是多少以及是否允许使用特殊字符 根据当前的 HTML 4 和 5 规范 标题长度没有限制 但 IE 浏览器有 512 个字符的限制HTML 4 01 http msdn micros
  • 右侧对齐不浮动

    我有一个聊天小部件 我正在向其中添加一些样式 但是 我很难使 用户 聊天气泡与屏幕右侧对齐 当我使用向右浮动和向左浮动 另一侧 时 div 不再正确定位 因为它们似乎只是转到相对 div 的右侧 我希望它也能够附加 div 这将导致溢出 y
  • 检测滚动到 DIV 底部

    我想检测我是否到达了 div 的底部 我的 div 高度为 400px 溢出隐藏 我不知道正常高度但超过400px 我正在使用这段代码 但它不起作用 任何想法 if article txt scrollTop article txt hei
  • 如何水平和垂直对齐内联块

    什么是最好 最干净的使用CSS对齐 dates div位于标题的右侧 垂直于中间 I tried float right 但这不允许vertical align 我想避免使用浮动 所以我使用inline block 并使用相对定位 有没有更
  • 将画布下载为 PNG 图像[重复]

    这个问题在这里已经有答案了 当我尝试将画布下载为 PNG 图像时 浏览器会在新页面中打开该图像 但不下载它 我的下载代码 btnScaricaEtichetta click function console log Download loc

随机推荐