API センター ポータルをカスタマイズする

この記事では、API センター ポータル (プレビュー) でカスタマイズできる設定について説明します。 API センター ポータルは、開発者や組織内の他の利害関係者が API センター内の API を検出するために使用する Azure で管理される Web サイトです。

API Center ポータルを初期使用とサインイン用に設定するには、「 API センター ポータルを設定する」を参照してください。

ポータルの設定ページ

Azure portal で API センター ポータルの設定を構成します。 設定ページにアクセスするには:

1. Azure portal で API センターに移動します。
2. API センター ポータルで、[設定] を選択します。
3. タブをクリックして、設定を表示およびカスタマイズします。
4. [ 保存と発行] を 選択して変更を適用します。

サイト プロファイル

[ サイト プロファイル ] タブで、必要に応じて、発行済みポータルの上部バーに表示されるカスタム名を指定します。

API の可視性

[ API の可視性 ] タブで、API Center ポータル ユーザーに対して検出可能な (表示可能な) API を制御します。 可視性の設定は、API センター ポータルのすべてのユーザーに適用されます。

API Center ポータルでは 、Azure API Center データ プレーン API を使用して API センターで API を取得して表示します。既定では、Azure RBAC アクセス許可を持つサインインしているユーザーのすべての API が表示されます。

特定の API のみを表示するには、組み込みのプロパティに基づいて API のフィルター条件を追加します。 たとえば、特定の種類 (REST や GraphQL など) の API のみを表示するか、特定の仕様形式 (OpenAPI など) に基づいて API を表示することを選択します。

匿名アクセス

[ API の可視性 ] タブで、必要に応じて Azure API Center データ プレーン API への匿名読み取りアクセスを有効にします。これにより、認証されていないユーザーは直接 API 呼び出しによって API インベントリを検出できます。 たとえば、この設定を有効にすると、API センター ポータルを セルフホスト するときに、認証されていないユーザーが API を検出できるようになります。

セマンティック検索

[ セマンティック検索 ] タブで有効にした場合、API センター ポータルは、API 名、説明、および必要に応じてカスタム メタデータに基づいて構築された AI 支援 セマンティック検索 を使用して、基本的な名前ベースの API 検索を補完します。 セマンティック検索は、 Standard プランでのみ使用できます。

ユーザーは自然言語クエリを使用して API を検索できるため、意図に基づいて API を簡単に見つけることができます。 たとえば、開発者が "インベントリ管理用の API が必要です" と検索した場合、API 名や説明にこれらの正確な単語が含まれていない場合でも、ポータルは関連する API を提案できます。

API センター ポータルにサインインするときに AI 支援検索を使用するには、検索ボックスをクリックし、[ AI で検索] を選択し、クエリを入力します。

カスタム メタデータ

[ メタデータ ] タブで、必要に応じて、API の詳細とセマンティック検索で公開する カスタム メタデータ プロパティを選択します。

API のテスト コンソールへのアクセスを有効にする

API センターで API とその特定のバージョンへのアクセスをきめ細かく承認するようにユーザー設定を構成できます。 たとえば、認証に API キーを使用するように特定の API バージョンを構成し、特定のユーザーのみがそれらのキーを使用して認証できるようにするアクセス ポリシーを作成します。

アクセス ポリシーは、API センター ポータルの API の "この API を試す" 機能にも適用され、適切なアクセス ポリシーを持つポータル ユーザーのみがそれらの API バージョンのテスト コンソールを使用できるようにします。 API へのアクセスの承認の詳細

関連コンテンツ

• API センター ポータルを設定する
• Visual Studio Code で Azure API Center ポータルを有効にして表示する
• API センター ポータルをセルフホストする