跳到内容

检测您的 Swagger UI 版本

有时,您需要知道您使用的 Swagger UI 的版本。

第一步是检测您当前使用的主版本,因为检测版本的方法已更改。如果您的 Swagger UI 经过大量修改,并且您无法从外观和感觉中检测到您使用的主版本,您必须尝试两种方法来获取确切的版本。

为了帮助您直观地检测您正在使用的版本,我们包含了支持图像。

Swagger UI 3.x

Swagger UI 3

Swagger UI 3.x 的一些独特标识符

  • API 版本显示为标题旁边的徽章。
  • 如果有方案或授权,它们将出现在操作上方的栏中。
  • “试用”功能默认情况下未启用。
  • 操作中的所有响应代码都出现在参数之后。
  • 操作之后有一个模型部分。

如果您已确定这是您拥有的版本,要查找确切的版本

  • 打开浏览器的 Web 控制台(浏览器之间会有所变化)
  • 在控制台中键入 JSON.stringify(versions) 并执行调用。
  • 结果应类似于 swaggerUi : Object { version: "3.1.6", gitRevision: "g786cd47", gitDirty: true, … }
  • 从该示例中获取的版本将为 3.1.6

注意:此功能是在 3.0.8 中添加的。如果您无法执行它,您可能正在使用旧版本,在这种情况下,第一步是升级。

Swagger UI 2.x 及更低版本

Swagger UI 2

Swagger UI 2.x 的一些独特标识符

  • API 版本显示在页面底部。
  • 不渲染方案。
  • 如果渲染,授权将出现在导航栏旁边。
  • 默认情况下启用“试用”功能。
  • 成功的响应代码将出现在参数上方,其余的则出现在参数下方。
  • 操作之后没有模型部分。

如果您已确定这是您拥有的版本,要查找确切的版本

  • 导航到 UI 的源。在您的磁盘上或通过浏览器中的“查看页面源代码”功能。
  • 查找并打开 swagger-ui.js
  • 在页面顶部,会有一个包含 Swagger UI 确切版本的注释。此示例显示版本 2.2.9
1
/**
2
* swagger-ui - Swagger UI is a dependency-free collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API
3
* @version v2.2.9
4
* @link https://swagger.org.cn
5
* @license Apache-2.0
6
*/