第4章 デベロッパーポータルでの ActiveDocs の公開
本チュートリアルでは、デベロッパーポータルで ActiveDocs を公開する方法について説明します。
Swagger が満足できるものになり、それを 3scale に追加 したら、続いてこれを公開してデベロッパーポータルにリンクを設定し、API 開発者が使用できるようにします。
以下のスニペットをデベロッパーポータルの任意のページのコンテンツに追加する必要があります。この操作は、デベロッパーポータルの CMS で行わなければなりません。SERVICE_NAME はサービス仕様のシステム名 (この例では pet_store) であることに注意してください。
注記
- 1 ページに指定できるサービスは 1 つだけです。複数の仕様を表示する場合は、別々のページで表示するのが最善の方法です。
- このスニペットには jQuery が必要ですが、デフォルトでデベロッパーポータルの main layout に含まれています。main layout から jQuery 依存関係を削除する場合は、この依存関係を ActiveDocs が含まれるページに追加する必要があります。
- CMS ページで Liquid タグが有効になっていることを確認します。
-
Liquid タグで使用されるバージョン
{{ '{% active_docs version: "2.0" ' }}%}
は、Swagger 仕様のバージョンに対応している必要があります。 - 外部ソースから仕様を取得する場合は、以下のように JavaScript コードを変更します。
$(function () { window.swaggerUi.options['url'] = "SWAGGER_JSON_URL"; window.swaggerUi.load(); });
$(function () {
window.swaggerUi.options['url'] = "SWAGGER_JSON_URL";
window.swaggerUi.load();
});
スニペット 14 行目の例を確認してください。この行は、コメントブロックの中には置かないでください。