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を示しています
/**
 * 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
 * @version v2.2.9
 * @link https://swagger.dokyumento.jp
 * @license Apache-2.0
 */