2.3. Swagger ユーザーインターフェースの 2.1.3 から 2.2.10 へのアップグレード
使用している 3scale が Swagger UI 2.1.3 の組み込まれているバージョンである場合、Swagger UI バージョン 2.2.10 にアップグレードできます。
3scale デベロッパーポータルで以前実装されていた Swagger UI 2.1.3 は、Documentation
ページに 1 つの {% active_docs version: "2.0" %}
Liquid タグがあることが条件です。3scale で Swagger 2.2.10 がサポートされたことに伴い、実装メソッドは複数の Liquid タグ cdn_asset
と include
に変わっています。
Swagger UI 2.1.3 以前のバージョンについては、3scale では、引き続き古い active_docs
Liquid タグメソッドを使用して UI を呼び出します。
前提条件
- 管理者アクセスを持つ 3scale インスタンス
- Swagger UI 2.1.3 が含まれる 3scale インスタンス
手順
- 3scale 管理ポータルにログインします。
-
Developer Portal
→Documentation
ページの順に移動するか、Swagger UI 実装を更新するページに移動します。 コードペインの
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' %}
(オプション) デフォルトでは、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}}";