2.3. 将 Swagger 用户界面 2.1.3 升级到 2.2.10

如果您使用包含 Swagger UI 2.1.3 的 3scale 版本,您可以升级到 Swagger UI 2.2.10。

之前的 3scale 开发人员门户网站中 Swagger UI 2.1.3 实施依赖于单个 {% active_docs 版本:在 Documentation 页面中,"2.0" %} 精简标签。随着在 3scale 中引入了对 Swagger 2.2.10 的支持,实施方法会更改为多个 cdn_asset 并包括适当的 标签。

注意

对于 Swagger UI 2.1.3 及更早版本,3scale 继续使用传统的 active_docs Mobile tag 方法调用 UI。

先决条件

  • 具有管理员访问权限的 3scale 实例。
  • 包含 Swagger UI 2.1.3 的 3scale 实例。

步骤

  1. 登录您的 3scale 管理门户。
  2. 导航到 Developer PortalDocumentation 页面,或您要更新 Swagger UI 的页面
  3. 在代码窗格的 Draft 选项卡中,替换 {% active_docs 版本:"2.0" %} 使用 cdn_asset Tag 以及新的 part shared/swagger_ui 标记:

    {% cdn_asset /swagger-ui/2.2.10/swagger-ui.js %}
    {% cdn_asset /swagger-ui/2.2.10/swagger-ui.css %}
    
    {% include 'shared/swagger_ui' %}
  4. 可选:默认情况下,Swagger UI 加载 API > ActiveDocs 中发布的 ActiveDocs 规格。通过在 window. swaggerUi. load()前面添加以下 window.swaggerUi.options 来加载不同的规格,其中 <SPEC_SYSTEM_NAME> 是您要加载的规格的系统名称:

    window.swaggerUi.options['url'] = "{{provider.api_specs.<SPEC_SYSTEM_NAME>.url}}";