API センター ポータルを設定する

この記事では、 API センター ポータル (プレビュー) を設定する方法について説明します。これは、開発者や組織内の他の利害関係者が API センターで API を検出するために使用できる Azure で管理される Web サイトです。 サインインしているユーザーは、API を参照してフィルター処理し、API 定義やドキュメントなどの API の詳細を表示できます。 API 情報へのユーザー アクセスは、Microsoft Entra ID と Azure ロールベースのアクセス制御に基づいています。

[前提条件]

• Azure サブスクリプション内の API センター。 まだ作成していない場合は、「クイック スタート: API センターを作成する」を参照してください。

• Azure サブスクリプションに関連付けられている Microsoft Entra テナントでアプリ登録を作成するためのアクセス許可と、API センター内のデータへのアクセス権を付与するためのアクセス許可。

Microsoft Entra アプリ登録を作成する

まず、Microsoft Entra ID テナントでアプリ登録を構成します。 アプリの登録により、API センター ポータルは、サインインしているユーザーの代わりに API センターからデータにアクセスできます。

API Center では、アプリの登録を自動的に設定することも、アプリの登録を手動で作成することもできます。

アプリの登録を自動的に設定する

アプリの登録を自動的に設定するには、次の手順に従います。

1. Azure portal で、API センターに移動します。
2. 左側のメニューで、 API センター ポータル>Settings を選択します。
3. [ ID プロバイダー ] タブで、[ セットアップの開始] を選択します。
4. [保存と発行] を選択します。

アプリの登録を手動で設定する

アプリの登録を手動で作成する場合は、次の手順に従います。

1. Azure portal で、[Microsoft Entra ID]>[アプリの登録] の順に移動します。

2. [+ 新規登録] を選択します。

3. [アプリケーションを登録] ページで、次のように値を設定します。

   1. 名前を api-center-portal などのわかりやすい名前に設定する
   2. [サポートされているアカウントの種類] で、[この組織ディレクトリに含まれるアカウント (シングル テナント)] を選択します。
   3. [リダイレクト URI] で、[シングルページ アプリケーション (SPA)] を選択し、URI を設定します。 API Center ポータルのデプロイの URI を、次の形式で入力します: https://<service-name>.portal.<___location>.azure-api-center.ms。 <service name>と<___location>は、API センターの名前とデプロイ先の場所 (例: https://myapicenter.portal.eastus.azure-api-center.ms) に置き換えます。
   4. 登録 を選択します。

VS Code 拡張機能の追加のリダイレクト URI を構成する

Api Center の Visual Studio Code 拡張機能で API センター ポータル ビューを有効にする場合は、アプリの登録で次のリダイレクト URI も構成します。

1. Azure portal で、アプリの登録に移動します。

2. [ 管理>認証 ] ページで、[ プラットフォームの追加 ] を選択し、[ モバイル アプリケーションとデスクトップ アプリケーション] を選択します。

3. 次の 3 つのカスタム リダイレクト URI を構成します。
   https://vscode.dev/redirect
http://localhost
ms-appx-web://Microsoft.AAD.BrokerPlugin/<application-client-id>
   

   <application-client-id>を、このアプリのアプリケーション (クライアント) ID に置き換えます。 この値は、アプリ登録の [概要 ] ページで確認できます。

API センター ポータルを構成して発行する

API センター ポータル アプリの登録を作成したら、API センター ポータルを構成して発行する必要があります。 Azure portal で次の手順を完了します。

1. Azure portal で、API センターに移動します。
2. 左側のメニューの API センター ポータルで、[ ポータルの設定] を選択します。
3. [ ID プロバイダー ] タブで、[ セットアップの開始] を選択します。 表示された画面で、次の操作を行います。
   1. [クライアント ID] に、前のセクションで作成したアプリ登録のアプリケーション (クライアント) ID を入力します。
   2. リダイレクト URI がアプリ登録で構成した値であることを確認します。
   3. [保存と発行] を選択します。
4. [ サイト プロファイル ] タブで、API センター ポータルの上部バーに表示する Web サイト名を入力します。 [保存と発行] を選択します。
5. [ API の可視性 ] タブで、必要に応じてポータルで検出可能にする API のフィルターを追加します。 [保存と発行] を選択します。 API の可視性の詳細

API センター ポータルにアクセスできるようになりました。

• [ ポータルの設定] ページで、[ API センター ポータルの表示 ] を選択して、新しいタブでポータルを開きます。
• または、ブラウザーに次の URL を入力し、 <service-name> と <___location> を API センターの名前とデプロイ先の場所に置き換えます。
  https://<service-name>.portal.<___location>.azure-api-center.ms

API の可視性

API 可視性設定は、API Center ポータル ユーザーに対して検出可能な (表示可能な) API を制御します。 API センター ポータルでは、データ プレーン API を使用して API を取得して表示し、既定では API センター内のすべての API を取得します。 可視性の設定は、API センター ポータルのすべてのユーザーに適用されます。

特定の API のみを表示するには、API Center ポータルの設定の [API の可視性 ] タブに移動します。 ここでは、組み込みまたはカスタム API メタデータ プロパティに基づいて API のフィルター条件を追加します。 たとえば、特定の種類 (REST や GraphQL など) の API のみを表示するか、特定の仕様形式 (OpenAPI など) に基づいて API を表示することを選択できます。 また、API を分類するカスタム メタデータ プロパティの値を選択することもできます。

.

Microsoft Entra ユーザーとグループによるポータルへのサインインを有効にする

サインインを有効にするには、組織内のユーザーまたはグループに Azure API Center データ閲覧者 ロールを割り当てます。スコープは API センターです。

ユーザーとグループにロールを割り当てるための詳細な前提条件と手順については、「Azure portal を使用して Azure ロールを割り当てる」を参照してください。 簡単な手順を次に示します。

1. Azure portal で、API センターに移動します。
2. 左側のメニューで、[アクセス制御 (IAM)]>[+ ロールの割り当ての追加] の順に選択します。
3. [ロールの割り当ての追加] ペインで、次のように値を設定します。
   1. [ロール] ページで、[Azure API センター データ閲覧者] を検索して選択します。 [次へ] を選択します。
   2. [メンバー] ページの [アクセスの割り当て先] で、[ユーザー、グループ、またはサービス プリンシパル]>[+ メンバーの選択] の順に選択します。
   3. [メンバーの選択] ページで、ロールを割り当てるユーザーまたはグループを検索して選択します。 [選択]、[次へ] の順にクリックします。
   4. ロールの割り当てを確認し、[レビューと割り当て] を選択します。

ポータルへのアクセスを構成した後、構成済みのユーザーはポータルにサインインし、API センターで API を表示できます。

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

API センターで API とその特定のバージョンへのアクセスをきめ細かく承認するようにユーザー設定を構成できます。 たとえば、認証に API キーを使用するように特定の API バージョンを構成し、特定のユーザーのみがそれらのキーを使用して認証できるようにするアクセス ポリシーを作成します。 このポリシーは、API センター ポータルの API の "この API を試す" 機能にも適用され、適切なアクセス ポリシーを持つポータル ユーザーのみがそれらの API バージョンのテスト コンソールを使用できるようにします。 API へのアクセスの承認の詳細

API Center ポータルでの API の検出と使用

API センター ポータルは、組織内で API を使用および作成する開発者の作業をサポートし、効率化します。 サインインしているユーザーは次のことができます。

• 名前または AI 支援セマンティック検索を使用して API を検索する

• 種類またはライフサイクル ステージで API をフィルター処理する

• エンドポイント、メソッド、パラメーター、応答形式などの API の詳細と定義を表示する

• ローカル コンピューターに API 定義をダウンロードするか、Visual Studio Code で開く

• API キー認証または OAuth 2.0 承認をサポートする API を試す

AI を使用して検索する

Azure API Center の Standard プランでは、API Center ポータルは、API 名と説明に基づいて構築された AI 支援 セマンティック検索 を使用して、基本的な名前ベースの API 検索を補完します。 ユーザーは自然言語クエリを使用して API を検索できるため、意図に基づいて API を簡単に見つけることができます。 たとえば、開発者が "在庫管理用の API が必要です" と検索した場合、名前や説明にこれらの正確な単語が含まれていない場合でも、ポータルは関連する API を提案できます。

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

API Management ポータルと API Center ポータル

Azure API Management と Azure API Center サービスの両方に、開発者が API を検出して使用するためのポータルが用意されています。

• API Management 開発者ポータルを使用すると、ユーザーはマネージド API を検索し、その使用方法を学習し、アクセスを要求し、テストすることができます。
• API センター ポータル (プレビュー) は、ユーザーが組織の完全な API インベントリを検出してフィルター処理できるマルチゲートウェイ ポータルです。

2 つのポータルは一部の機能を共有していますが、違いもあります。 次の表は、現在の機能を比較して、使用するポータルを決定するのに役立ちます。 1 つのポータルを好む組織もあれば、両方が必要な組織もあります。

¹ API センター ポータルには、Azure API Management やその他のプラットフォームで管理されている API や、開発中のアンマネージド API や API など、組織内のすべての API を含めることができます。

関連コンテンツ

• Visual Studio Code で Azure API Center ポータルを有効にして表示する