Azure API Management の開発者ポータルでページのコンテンツとレイアウトを変更する
Azure API Management で開発者ポータルをカスタマイズする基本的な方法は 3 つあります。
- 静的ページとページ レイアウト要素の内容を編集 (このガイドで説明します)
- 開発者ポータル全体のページ要素で使用されるスタイルを更新する
- ポータル によって生成されたページに使用されるテンプレート (API ドキュメント、製品、ユーザー認証など) を変更する
可用性
重要
この機能は、API Management の Premium、Standard、Basic、Developer レベルで使用できます。
v2 レベル (プレビュー) での機能の利用可能性については、v2 レベルの概要を参照してください。
開発者ポータル ページの構造
開発者ポータルは、コンテンツ管理システムに基づいています。 すべてのページのレイアウトは、ウィジェットと呼ばれる小さなページ要素のセットに基づいて構築されます。
すべてのウィジェットは編集可能です。
- 個々のページに固有のコア コンテンツは、"コンテンツ" ウィジェットに存在します。 ページを編集するということは、このウィジェットの内容を編集することを意味します。
- すべてのページ レイアウト要素は、残りのウィジェットに含まれています。 これらのウィジェットに加えられた変更は、すべてのページに適用されます。 これらは"レイアウト ウィジェット" と呼ばれます。
日々のページ編集では、多くの場合、コンテンツ ウィジェットだけが変更され、個々のページごとに異なるコンテンツが含まれます。
レイアウト ウィジェットの内容を変更する
開発者ポータルには、Azure Portal からアクセスできます。
API Management インスタンスのツールバーから 開発者ポータル をクリックします。
ウィジェットの内容を編集するには、左側の Developer ポータル メニューから 2 つのペイント ブラシで構成されるアイコンをクリックします。
ヘッダーの内容を変更するには、左側の一覧の [ヘッダー] セクションまでスクロールします。
ウィジェットはフィールド内から編集可能です。
変更を発行する準備ができたら、ページの下部にある [発行] をクリックします。
これで、開発者ポータル内のすべてのページに新しいヘッダーを表示できるようになります。
次のステップ
- 開発者ポータル全体のページ要素で使用されるスタイルを更新する
- ポータル によって生成されたページに使用されるテンプレート (API ドキュメント、製品、ユーザー認証など) を変更する