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，所以添加< code >

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" />

我不知道是否有更好的方法，或者这种方法是否有局限性，例如跨域问题。