Azure API Management で開発者ポータルのページのコンテンツとレイアウトを変更する

  • [アーティクル]

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

可用性

重要

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

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

開発者ポータルのページの構造

開発者ポータルは、コンテンツ管理システムがベースとなっています。 すべてのページのレイアウトは、ウィジェットと呼ばれる小さなページ要素のセットを基にして構築されています。

開発者ポータル ページの構造

ウィジェットはすべて編集できます。

  • 各ページ固有の中心的なコンテンツは、"コンテンツ" ウィジェットに存在します。 ページを編集することは、このウィジェットの内容を編集することを意味します。
  • すべてのページ レイアウト要素は、残りのウィジェットに含まれます。 これらのウィジェットに加えられた変更は、すべてのページに適用されます。 これらは、"レイアウト ウィジェット" と呼ばれます。

日常的なページの編集では、通常、ページごとに異なる内容が含まれるコンテンツ ウィジェットのみが変更されます。

レイアウト ウィジェットの内容の変更

開発者ポータルには、Azure Portal からアクセスすることができます。

  1. API Management インスタンスのツール バーの [開発者ポータル] をクリックします。

  2. ウィジェットの内容を編集するには、左側の [開発者ポータル] メニューにある 2 つのペイント ブラシのアイコンをクリックします。

  3. ヘッダーの内容を変更するには、左側の一覧で [ヘッダー] セクションまでスクロールします。

    ウィジェットは、フィールド内から編集することができます。

  4. 変更を発行する準備ができたら、ページの下部の [発行] をクリックします。

以後、この新しいヘッダーが開発者ポータル内のすべてのページに表示されます。

次のステップ