是否可以在 JSON Swagger 文件中创建指向特定 API 的 HTML 链接？答案

【问题标题】：Is it possible to create an HTML link to a specific API within a JSON Swagger file?是否可以在 JSON Swagger 文件中创建指向特定 API 的 HTML 链接？
【发布时间】：2022-01-28 08:22:03
【问题描述】：

我有类似 https://gitlab.com//blah/blah/Orders_Swagger.json 的 URL 的招摇文件。我正在构建一些链接到这些文件的文档；效果很好。 Gitlab 以漂亮的格式呈现页面。但是有些 swagger 文件有几十个 API，有时我想引用一个特定的、关键的 API，而不仅仅是将用户带到页面顶部。

【问题讨论】：

我相信 GitLab 使用 Swagger UI 作为渲染器。这是否回答了您的问题——How to link to another endpoint in Swagger UI？
我相信每个 API 的 HTML 元素都有一个可以在 URL 片段中锚定的 ID。例如，此link 将直接将您带到页面底部的端点（获取访问令牌）：https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/api/openapi/openapi.yaml#operations-access_tokens-accessTokens_get URL 片段#operations-access_tokens-accessTokens_get 在页面加载时将您锚定到特定端点。这对你有用吗？
这就是我正在寻找的东西，是的。但是，您发布的链接只是将我带到页面顶部，我已经可以做到。

标签： html json hyperlink gitlab swagger

【解决方案1】：

Swagger UI 支持“deepLinking=true”配置参数。它被支持设置为假。 Gitlab 嵌入了 Swagger UI，但是没有提供设置这个参数的方法，所以在服务端是关闭的。

但是，您可以通过在 URL 中传递参数来启用它：&deepLinking=1

因此，一个完整的、特定于 API 的 URL 将如下所示： https://gitlab.com/company/blah/blah/Swagger.json?deepLinking=1#/section/targetApiName

【讨论】：