深度链接

Swagger UI 允许您深度链接到规范中的标签和操作。当 Swagger UI 在运行时接收到 URL 片段时，它将自动展开并滚动到指定的标签或操作。

用法

👉🏼 将 deepLinking: true 添加到 Swagger UI 配置以启用此功能。这在 dist/index.html 中进行了演示。

当您展开标签或操作时，Swagger UI 将自动使用指向该项目的深度链接更新其 URL 片段。相反，当您折叠标签或操作时，Swagger UI 将清除 URL 片段。

您还可以右键单击标签名称或操作路径以复制指向该标签或操作的链接。

片段格式

片段以两种方式之一格式化

• #/{tagName}，以触发特定标签的焦点
• #/{tagName}/{operationId}，以触发标签内特定操作的焦点

operationId 是规范中提供的显式 operationId（如果存在）。否则，Swagger UI 通过组合操作的路径和方法，同时转义非字母数字字符来生成隐式 operationId。

常见问题解答

我在需要控制 URL 片段的应用程序中使用 Swagger UI。如何禁用深度链接？

此功能默认禁用，但您可以将 deepLinking: false 作为配置项传递到 Swagger UI 中以确保禁用。

我可以链接到多个标签或操作吗？

不，不支持此操作。

我可以折叠除我链接到的操作或标签之外的所有内容吗？

当然 - 使用 docExpansion: none 折叠所有标签和操作。您的深度链接将优先于设置，因此只会展开您指定的标签或操作。