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

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

openapi3 / swagger的描述文本中的嵌入式图像

1 个答案: