Azure API Management 開発者ポータルをテンプレートを使用してカスタマイズする方法

[アーティクル]
11/04/2019

Azure API Management で開発者ポータルをカスタマイズする基本的な方法は 3 つあります。

テンプレートは、システムで生成された開発者ポータルページのコンテンツ (API ドキュメント、製品、ユーザー認証など) をカスタマイズするために使用します。 DotLiquid 構文と、用意されているローカライズされた文字列リソース、アイコン、およびページコントロールのセットを使用して、表示されるページの内容を自由に構成できます。

Note

以下のドキュメントの内容は、非推奨の開発者ポータルに関するものです。 2023 年 10 月に廃止され、すべての API Management サービスから削除されるまで、通常どおりに引き続き使用できます。非推奨のポータルでは、重要なセキュリティ更新プログラムのみを受信します。詳細については、次の記事をご覧ください。

可用性

重要

この機能は、API Management の Premium、Standard、Basic、Developer レベルで使用できます。

v2 レベル (プレビュー) での機能の可用性については、 v2 レベルの概要に関するページを参照してください。

開発者ポータルテンプレートの概要

テンプレートの編集は、管理者としてログインしているときに開発者ポータルから実行できます。開発者ポータルにアクセスするには、まず Azure portal を開き、API Management インスタンスのサービスツールバーにある [開発者ポータル] をクリックします。

開発者ポータルテンプレートにアクセスするには、左側のカスタマイズアイコンをクリックしてカスタマイズメニューを表示し、 [テンプレート] をクリックします。

テンプレートの一覧には、開発者ポータルのさまざまなページをカバーするテンプレートのカテゴリが表示されます。各テンプレートは異なりますが、それらを編集して変更を発行する手順は同じです。テンプレートを編集するには、テンプレートの名前をクリックします。

テンプレートをクリックすると、そのテンプレートによってカスタマイズできる開発者ポータルのページが表示されます。この例では、製品リスト テンプレートが表示されています。 製品リスト テンプレートは、赤色の四角形によって示されている画面の領域を制御します。

製品リストテンプレート

ユーザープロファイル テンプレートなどのいくつかのテンプレートと同じように、同じページのさまざまな部分をカスタマイズします。

各開発者ポータルテンプレート用のエディターでは、ページの下部に 2 つのセクションが表示されます。左側にはテンプレートの編集ウィンドウが表示され、右側にはテンプレートのデータモデルが表示されます。

テンプレート編集ウィンドウには、開発者ポータルの対応するページの外観と動作を制御するマークアップが含まれています。テンプレートのマークアップでは、 DotLiquid 構文を使用します。 DotLiquid 用の一般的なエディターの 1 つに、設計者向け DotLiquidがあります。編集中にテンプレートに加えられた変更はブラウザーにリアルタイムで表示されますが、テンプレートを保存して発行するまで顧客の目に触れることはありません。

テンプレートのマークアップ

テンプレートデータ ウィンドウには、特定のテンプレートで使用できるエンティティのデータモデル用のガイドが提供されます。このガイドは、開発者ポータルに現在表示されているライブデータを表示することによって提供されます。テンプレートウィンドウは、 テンプレートデータ ウィンドウの右上にある長方形をクリックすることで拡大できます。

テンプレートのデータモデル

前の例には、次の例に示す [Template data](テンプレートデータ) ウィンドウに表示されたデータから取得され、開発者ポータルに表示される 2 つの製品があります。

{
    "Paging": {
        "Page": 1,
        "PageSize": 10,
        "TotalItemCount": 2,
        "ShowAll": false,
        "PageCount": 1
    },
    "Filtering": {
        "Pattern": null,
        "Placeholder": "Search products"
    },
    "Products": [
        {
            "Id": "56ec64c380ed850042060001",
            "Title": "Starter",
            "Description": "Subscribers will be able to run 5 calls/minute up to a maximum of 100 calls/week.",
            "Terms": "",
            "ProductState": 1,
            "AllowMultipleSubscriptions": false,
            "MultipleSubscriptionsCount": 1
        },
        {
            "Id": "56ec64c380ed850042060002",
            "Title": "Unlimited",
            "Description": "Subscribers have completely unlimited access to the API. Administrator approval is required.",
            "Terms": null,
            "ProductState": 1,
            "AllowMultipleSubscriptions": false,
            "MultipleSubscriptionsCount": 1
        }
    ]
}

製品リスト テンプレートのマークアップは、製品のコレクションを反復処理して各製品の情報とリンクを表示することによってデータを処理して、目的の出力を提供します。マークアップの <search-control> 要素と <page-control> 要素に注目してください。これらは、ページでの検索コントロールとページングコントロールの表示を制御します。 ProductsStrings|PageTitleProducts は、ページの h2 ヘッダーテキストを含むローカライズされた文字列参照です。開発者ポータルテンプレートで使用できる文字列リソース、ページコントロール、およびアイコンの一覧については、 API Management 開発者ポータルテンプレートリファレンスに関するページを参照してください。

<search-control></search-control>
<div class="row">
    <div class="col-md-9">
        <h2>{% localized "ProductsStrings|PageTitleProducts" %}</h2>
    </div>
</div>
<div class="row">
    <div class="col-md-12">
    {% if products.size > 0 %}
    <ul class="list-unstyled">
    {% for product in products %}
        <li>
            <h3><a href="/products/{{product.id}}">{{product.title}}</a></h3>
            {{product.description}}
        </li>
    {% endfor %}
    </ul>
    <paging-control></paging-control>
    {% else %}
    {% localized "CommonResources|NoItemsToDisplay" %}
    {% endif %}
    </div>
</div>