搜索

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

download PDF

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

以前在 3scale 开发人员门户中实现的 Swagger UI 2.1.3 需要在 Documentation 页中存在一个 {% active_docs version: "2.0" %} liquid 标签。随着 3scale 中对 Swagger 2.2.10 的支持,实施方法会更改为多个 cdn_assetinclude liquid 标签。

注意

对于 Swagger UI 2.1.3 及更早版本的版本,3scale 继续使用旧的 active_docs liquid 标签方法来调用 UI。

先决条件

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

流程

  1. 登录您的 3scale 管理门户。
  2. 导航到 Developer Portal Documentation 页面,或您要更新 Swagger UI 的页面。
  3. 在代码窗格的 Draft 选项卡中,将 {% active_docs version: "2.0" %} liquid 标签替换为 cdn_asset liquid 标签和新的 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 会加载 APIs > ActiveDocs 中发布的 ActiveDocs 规格。通过在 window.swaggerUi.load(); 行前添加 window.swaggerUi.options 行来加载不同的规格(其中 <SPEC_SYSTEM_NAME> 是需要加载的规格系统名称):

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

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

© 2024 Red Hat, Inc.