如何使用 swagger-ui 在 swagger 文档中嵌入图像？

Question

我试图在我的 swagger 的 info 部分的 description 字段中包含一个图像，该图像使用 Swagger-UI 显示。到目前为止，我已经尝试过 GFM:

...
  "info": {
    "description": "![alt text][/static/img/image.png]"
  }
...

和普通老 HTML:

...
  "info": {
    "description": "<img alt=\"alt text\" src=\"/static/img/image.png\">"
  }
...

但是这两个都只是按照给定的方式呈现字符串而不显示图像。

有办法吗？

Answer 1

在您的第一个示例中，替换

![alt text][/static/img/image.png]

和

![alt text](/static/img/image.png)

请注意，图像路径用括号 () 表示，而不是方括号 []。

另见 。