首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >问答首页 >openapi3/swagger描述文本中的内联图像

openapi3/swagger描述文本中的内联图像
EN

Stack Overflow用户
提问于 2019-08-29 18:19:00
回答 1查看 3.5K关注 0票数 3

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

代码语言:javascript
运行
复制
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]"

有没有可能发生这样的事情?

EN

回答 1

Stack Overflow用户

发布于 2019-08-29 18:30:16

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

代码语言:javascript
运行
复制
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" />

我不知道是否有更好的方法,或者这种方法是否有局限性,比如跨来源问题。

票数 1
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/57708035

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档