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

4月 20, 2016 に投稿済み

Senior Content Developer, Azure.com

Azure API Management には、開発者ポータルの外観や操作感をカスタマイズするために使用できるカスタマイズ機能がいくつか用意されていますが、今回、開発者ポータル ページ自体のコンテンツをカスタマイズする手段が提供されました。提供されているテンプレートローカライズされた文字列リソースアイコンページ コントロールDotLiquid 構文のセットを使用することで、必要に応じてページのコンテンツを非常に柔軟に構成できます。

API Management には、開発者ポータルのさまざまなページを対象とする包括的なテンプレートのセットが用意されています。

API Management 開発者ポータルのテンプレート

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

API Management 開発者ポータルのテンプレート

各開発者ポータル テンプレート用のエディターでは、ページの下部に 2 つのセクションが表示されます。左側にはテンプレートの編集ウィンドウが表示され、右側にはテンプレートのデータ モデルが表示されます。テンプレート編集ウィンドウには、開発者ポータルの対応するページの外観と動作を制御するマークアップが含まれています。このマークアップを編集すると、ページのコンテンツを自在に変更できます。

API Management 製品リスト テンプレート

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

API Management テンプレート データ

加えた変更はすぐにブラウザーでプレビューが表示されるので自分で確認できますが、テンプレートを保存して公開するまで開発者には表示されません。

開始する

開発者ポータル テンプレートの使用方法については、「Azure API Management 開発者ポータルをテンプレートを使用してカスタマイズする方法」を参照してください。

開発者ポータルの API ページと操作ページにディスカッション ボードと評価を追加する方法を説明した動画を視聴するには、「Azure API Management 開発者ポータルをテンプレートを使用してカスタマイズする方法」を参照してください。