API の検出と使用

  • 5 分

API の検出と使用は、組織全体で API を使用する上で重要な部分です。

このユニットでは、API Center VS Code 拡張機能を使用して、API を簡単に検出して使用する方法について説明します。

前提条件

VS Code で API Center 拡張機能を使用して API を管理するには、次の手順を実行する必要があります。

次の Visual Studio Code 拡張機能は省略可能であり、示されている特定のシナリオでのみ必要です。

API の検出と使用

Visual Studio Code で組織の API カタログを直接表示し、すべての API、バージョン、定義、環境、デプロイを確認できます。 ひとめで、組織内で使用可能なすべての API の概要をすぐに確認できます。

しかし、組織に数百または数千の API がある場合はどうでしょうか。 その場合は、次に示すように、検索アイコンを使用して API を検索できます。

VS Code の検索 API オプションを示すスクリーンショット

API ドキュメントの表示

また、VS Code で API のドキュメントにすばやくアクセスしてプレビューし、お使いの API のエンドポイントをテストすることもできます。 VS Code に関する swagger のドキュメントを示すスクリーンショット

  1. タブから API Center 拡張機能を開きます。
  2. API Center のツリー ビューを展開して、API 定義を表示します。
  3. 定義を右クリックし、[Open API Documentation] を選択します。
  4. API 定義の Swagger UI を含む新しいタブが表示されます。
  5. エンドポイントを選択し、[Try it out] を選択し、必要なパラメーターを指定して [Execute] を選択します。

API を試す

API Center 拡張機能を使用すると、API Center で提供される API 定義に基づいて .http ファイルを表示できます。 このファイルでは、http 要求を直接送信し、エディターですぐに応答を表示できます。

Note

この機能を使用するには、REST Client 拡張機能をインストールする必要があります。 REST Client を使用して VS Code で API の .http を表示する方法を示すスクリーンショット

  1. API Center のツリー ビューを展開して、API 定義を表示します。
  2. 定義を右クリックし、[Generate HTTP File] を選択します。
  3. API 仕様によって設定された .http ドキュメントを表示する新しいタブが表示されます。
  4. 要求を行うには、エンドポイントを選択し、[要求の送信] を選択します。

SDK の生成

また、API Center 拡張機能では、Microsoft Kiota を使用して、OpenAPI の仕様で定義されているお気に入りの言語用の HTTP REST API 用のクライアントを生成します。 これにより、ビジネス ニーズを満たす API のすべての、または選択したエンドポイントのクライアントを即座に生成できます。

Note

この機能を使用するには、Microsoft Kiota 拡張機能をインストールする必要があります。

  1. API Center のツリー ビューを展開して、API 定義を表示します。

  2. 定義を右クリックし、[Generate API Client] を選択します。 Kiota OpenAPI Generator ウィンドウが表示されます。 Kiota を使用して VS Code で API クライアントを生成するオプションを選択する方法を示すスクリーンショット

  3. SDK に含める API エンドポイントと HTTP 操作を選択します。 エンドポイントにカーソルを合わせ、[+] ボタンを選択して追加したり、[-] を選択して削除したりすることができます。

  4. 完了したら、[再生] ボタンを選択して API クライアントを生成します。 Kiota を使用して VS Code で特定のエンドポイントを追加または削除するオプションを選択する方法を示すスクリーンショット

  5. [API クライアントの生成] を選択します。

    a. SDK 名、名前空間、出力ディレクトリに関する構成の詳細を入力します。

    b. 生成された SDK の言語を選択します。

セルフホステッドの API Center ポータル

API Center ポータルは、開発者や利害関係者が API インベントリ内の API をシームレスに検出して利用するための Web サイトです。 このセルフホステッド Web サイトを使用して、組織は Web ベースの API の検出と使用のエクスペリエンスをコンシューマーに提供します。

Contoso API Center ポータルまたは Web サイトのランディング ページを示すスクリーンショット

API プラットフォーム エンジニアは、内部と外部の両方のすべての API コンシューマーに対して、一元化されたスタンドアロンの場所を必要としています。 開始するには、次の手順を使用して、API Center ポータルのスターター テンプレートを使用できます。

Note

以下は、Azure Static Web Apps にデプロイする手順ですが、任意のインフラストラクチャにデプロイできます。

  1. API Center の参照実装コードをフォークします。

  2. Azure で静的 Web アプリ リソースを作成します。

  3. [デプロイの詳細] で、ソースとして [GitHub] を選択し、API Center のスターター コードを含むリポジトリに直接アクセスします。

  4. Static Web Apps によってビルド プリセットが検出され、React が設定されます。

  5. [アプリの場所] として / を入力します。

  6. [出力場所] として「dist」と入力します。

  7. ［作成］ を選択します

    Azure Static Web Apps の構成を示すスクリーンショット

Web サイトにコードが公開されて表示されるまでに最大 5 分かかる場合があります。

Static Web Apps で実行されている API Center ポータルを表示するには、Azure portal で作成した静的 Web アプリ リソースの [概要] タブから [ブラウザーでアプリを表示する] を選択します。

デプロイ済みの Web ポータルを示すスクリーンショット

ロールベースのアクセス制御の構成

管理者は、ロールベースのアクセス制御を使用して、組織の API Center 内の API と資産にアクセスするためのアクセス許可を割り当てる権限を完全に制御できます。

Note

既定では、API Center の管理者は API Center ポータルで API にアクセスできません。 管理者に Azure API センター データ閲覧者ロールを必ず割り当ててください。

API Center で API にアクセスするには、ユーザーがポータルにサインインし、API Center をスコープとした必要なアクセス許可を持っている必要があります。 サインインを有効にするには、こちらで説明されている手順に従って、組織内のユーザーまたはグループに Azure API Center のデータ閲覧者ロールを割り当てます。