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

Question

我试图在我的 swagger 部分description的字段中包含一个图像info，该图像通过 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)

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

另请参阅如何在 OpenAPI/Swagger UI 中使用 Markdown 格式化描述。