偵測您的 Swagger UI 版本
有時,您需要知道您使用的 Swagger UI 版本。
第一步是偵測您目前使用的主版本,因為偵測版本的方法已變更。如果您的 Swagger UI 已被大幅修改,並且您無法從外觀判斷您使用哪個主版本,您必須嘗試兩種方法來取得確切的版本。
為了幫助您視覺化偵測您使用的版本,我們已包含支援圖片。
Swagger UI 3.x
Swagger UI 3.x 的一些獨特識別符號
- API 版本會以徽章形式顯示在其標題旁邊。
- 如果有配置或授權,它們會顯示在操作上方的橫條中。
- 「試試看」功能預設為未啟用。
- 操作中的所有回應代碼都會顯示在參數之後。
- 操作之後有一個模型區段。
如果您已確定這是您擁有的版本,若要找到確切的版本
- 開啟瀏覽器的網路主控台 (在不同瀏覽器之間有所不同)
- 在主控台中輸入
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.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 API3 * @version v2.2.94 * @link https://swagger.dev.org.tw5 * @license Apache-2.06 */