深度連結

Swagger UI 允許您深入連結到規格中的標籤和操作。當在執行階段向 Swagger UI 提供 URL 片段時，它會自動展開並捲動至指定的標籤或操作。

使用

👉🏼 將 deepLinking: true 新增至您的 Swagger UI 組態，以啟用此功能。這已在 dist/index.html 中示範。

當您展開標籤或操作時，Swagger UI 會自動使用該項目的深度連結來更新其 URL 片段。相反地，當您摺疊標籤或操作時，Swagger UI 會清除 URL 片段。

您也可以按一下滑鼠右鍵標籤名稱或操作路徑，以複製該標籤或操作的連結。

片段以兩種方式之一格式化

operationId 是規格中提供的明確 operationId (如果存在)。否則，Swagger UI 會透過結合操作的路徑和方法來產生隱含的 operationId，同時逸出非字母數字字元。

我正在需要控制 URL 片段的應用程式中使用 Swagger UI。我要如何停用深度連結？

此功能預設為停用，但您可以將 deepLinking: false 作為組態項目傳遞至 Swagger UI 以確保停用。

我可以連結到多個標籤或操作嗎？

否，不支援此功能。

我可以摺疊除了我連結到的操作或標籤以外的所有項目嗎？

當然，使用 docExpansion: none 來摺疊所有標籤和操作。您的深度連結將優先於該設定，因此只會展開您指定的標籤或操作。