swagger - openapi3/swagger 描述文本中的内嵌图像

Question

是否可以在 openapi3.0/swagger 中将内嵌图像渲染为描述文本等的一部分？
在查看规范时，我能找到的只是在请求示例中链接到图像的能力，特别是。我想要的是能够在我的 API 的介绍性文本中包含图表等，类似于 markdown 等。示例:

openapi: 3.0.2
info:
  version: "1.0.0"
  title: "My API"
  description: "This API bla bla bla [block diagram] bla bla [another inline image]"

这样的事情有可能吗？

Answer 1

至少使用 ReDoc 渲染器，似乎可以在描述文本中直接使用 HTML，因此添加 <img src="./image.png" />似乎工作:

openapi: 3.0.2
info:
  version: "1.0.0"
  title: "My API"
  description: "This API bla bla bla <img src="./block-diagram.png" /> bla bla <img src="./another-inline-image.png" />

我不知道是否有更好的方法，或者这种方法是否存在诸如跨域问题之类的限制。