当前位置: 首页 > 知识库问答 >
问题:

如何使用swagger-用户界面在swagger留档中嵌入图像?

杜志
2023-03-14

我正试图在我的swagger的<code>info</code>部分的<code<description</code>字段中包含一个图像,该字段与swagger UI一起显示。到目前为止,我已经尝试过GFM:

...
  "info": {
    "description": "![alt text][/static/img/image.png]"
  }
...

和普通的旧HTML:

...
  "info": {
    "description": "<img alt=\"alt text\" src=\"/static/img/image.png\">"
  }
...

但这两种都只是按给定的方式呈现字符串,不显示图像。

有没有办法做到这一点?

共有1个答案

陈坚
2023-03-14

在第一个示例中,替换

![alt text][/static/img/image.png]

![alt text](/static/img/image.png)

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

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

 类似资料:
  • 有一个web应用程序在一个war文件中运行在tomcat中,作为其中的一部分,我用jax rs实现了jax rs RESTAPI,并由jersey绑定。这些RESTAPI有一些招摇过市的注释,但是我似乎无法使招摇过市的ui正常工作。 结构 我定义的运动衫配置 网状物xml 因此,当我在war文件中有swagger ui html文件时,我可以访问它们;本地主机:8181/warFile/docs。

  • 我有一个GET路由,我想在其中将url中的对象参数编码为查询字符串。 在编写 swagger 文档时,我基本上收到不允许我在类型参数中使用/类型的错误: 具有对象值的请求查询参数将在实际请求中编码。 即使 swagger在屏幕顶部显示错误,对象也会在 swagger UI 编辑器中正确呈现,但是该错误浮动在文档顶部。

  • 我想在我的 rest 服务的自动生成的 swagger ui 文档中添加一个标头参数字段。我使用Spring和Spring狐。 如您所见,我已经有一个体型参数。我只想添加一个标题类型。

  • 我正在使用swagger,swagger用户界面与Spring rest api来获得一个平台来测试/记录API,所以我需要在swagger用户界面中获得oAuth2授权,我在授权服务器上使用密码授权,所以我不得不使用包

  • 我正在阅读使用flask-rest x的swagger留档,并遵循示例。我知道为了为API获取的参数生成swagger文档,我应该这样做 然而,我找不到关于如何记录API响应主体的解释。不是响应代码,而是由例如get方法返回的结果。我要找的是如下内容: 有人知道这是否可能,如果可能,如何实现?

  • 我的设想如下。 我有一个swagger. json,例如:http://petstore.swagger.io/v2/swagger.json我想为上面的REST API使用生成的java客户端,例如: 扩展输出:<code>cica</code>,新宠物根据REST API实现进行存储。 我已经使用以下命令成功地为petstore生成了服务器存根: 但是这个 maven 项目代码是一个服务器代码