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を示しています。

/**
 * 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
 */