deepLinking パラメータ
Swagger UIを使用すると、仕様内のタグと操作にディープリンクできます。Swagger UIに実行時にURLフラグメントが提供されると、指定されたタグまたは操作が自動的に展開およびスクロールされます。
使用方法
👉🏼 Swagger UI設定に deepLinking: true を追加して、この機能を有効にします。これは、dist/index.html に示されています。
タグまたは操作を展開すると、Swagger UIは、そのアイテムへのディープリンクを使用してURLフラグメントを自動的に更新します。逆に、タグまたは操作を折りたたむと、Swagger UIはURLフラグメントをクリアします.
タグ名または操作パスを右クリックして、そのタグまたは操作へのリンクをコピーすることもできます。
フラグメントは、次の2つのいずれかの方法でフォーマットされます。
#/{tagName}：特定のタグのフォーカスをトリガーします#/{tagName}/{operationId}：タグ内の特定の操作のフォーカスをトリガーします
operationId は、仕様で明示的に提供されている場合は、その operationId です。それ以外の場合、Swagger UIは、操作のパスとメソッドを組み合わせて、英数字以外の文字をエスケープすることにより、暗黙的な operationId を生成します。
よくある質問
URLフラグメントを制御する必要があるアプリケーションでSwagger UIを使用しています。ディープリンクを無効にするにはどうすればよいですか？
この機能はデフォルトで無効になっていますが、deepLinking: false を設定項目としてSwagger UIに渡して、確実に無効にすることができます。
複数のタグまたは操作にリンクできますか？
いいえ、これはサポートされていません。
リンク先の操作またはタグ以外をすべて折りたたむことはできますか？
はい、できます。 docExpansion: none を使用して、すべてのタグと操作を折りたたみます。ディープリンクは設定よりも優先されるため、指定したタグまたは操作のみが展開されます。