跳到内容

检测您的 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
 */
© . All rights reserved.