VS Code 用の Cloud Code で Apigee API Management を設定する

このページは Apigee と Apigee ハイブリッドに適用されます。

Apigee Edge のドキュメントを表示する。

このページでは、Cloud Code for VS Code で Apigee API Management のローカル開発環境を作成する手順について説明します。ローカル開発環境の機能については、Apigee を使用したローカル開発の概要をご覧ください。

設定プロセスでは、このガイドの次の両方のセクションを完了する必要があります。

始める前に

VS Code の Apigee を設定して使用するには、次のものが必要です。

ローカル開発環境でログインする Google Cloud プロジェクト。API プロキシを開発してテストできる Apigee ローカルワークスペースを作成するには、プロジェクトを Apigee 用にプロビジョニングする必要があります。
（推奨）プロジェクトで Apigee API ハブをプロビジョニングしていること。API ハブの統合により、Cloud Code 内からエコシステム全体の API にアクセスして編集できます。API 仕様をテストするためのリモートモックサーバーの作成にも API ハブが必要です。

プロジェクトに API ハブを追加しない場合は、代わりに API ハブが有効になっている別のプロジェクトにプロジェクトを関連付けることもできます。プロジェクトを API ハブにアタッチする方法については、API ハブにランタイムプロジェクトをアタッチするをご覧ください。

実行するアクションについて Apigee ローカル開発で API ハブを使用するために必要なロールをご覧ください。
VS Code、VS Code の管理方法、設定へのアクセスや拡張機能のインストールなどの一般的な操作の実行方法に精通していること。VS Code のドキュメントをご覧ください。

Apigee API ハブの API を使用して API の設計手順とテスト手順を実行するには、次のロールが必要です。

タスク	必要なロール
API ハブの API を表示、編集する	Cloud API Hub 管理者または Cloud API Hub 編集者
API ハブに API を公開する	Cloud API Hub 管理者または Cloud API Hub 編集者
API をテストするためのリモートモックサーバーを設定して管理する	Artifact Registry 管理者 Cloud Build サービスアカウント Cloud Run 管理者 Service Usage 管理者 Identity and Access Management（IAM）の基本ロールと事前定義ロールのリファレンスをご覧ください。 Google Cloud CLI もインストールしている必要があります。

このセクションでは、VS Code のインストール手順と VS Code に Cloud Code 拡張機能をインストールする手順について説明します。これは、Apigee のローカル開発を設定する最初のステップであり、Apigee ローカル開発機能のいずれかを使用するためには必須です。

VS Code と Cloud Code 拡張機能をインストールするには:

ローカルマシンに、Visual Studio Code（VS Code）をダウンロードしてインストールします（まだインストールしていない場合）。
Cloud Code 拡張機能をインストールするの説明に沿って、Cloud Code 拡張機能をインストールします。ローカル環境で API プロキシを管理する場合は、このプロセスの一環として Docker をインストールします。
（推奨）Cloud Code 拡張機能の自動更新を有効にします。[設定] で [Extensions: Auto Update] を検索し、すべての拡張機能に対して、または個々の Cloud Code 拡張機能に対して有効にします。
VS Code を再起動します。

Apigee API プロキシの開発とテストにローカル開発環境を使用する場合は、このセクションの手順を完了します。また、これらの手順を完了して、OpenAPI 仕様から API プロキシを作成できるようにします。

インストール手順と設定手順を完了したら、Cloud Code の使用を開始します。