Apigee ワークスペースの管理

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

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

Apigee を使用して Visual Studio Code（VS Code）で API をローカルで開発するには、その前に、VS Code で Apigee の新しい Apigee ワークスペースを作成するか、既存の Apigee ワークスペースを開く必要があります。Apigee ワークスペースには、ローカル開発に必要なディレクトリ構造が含まれています。

以降のセクションでは、Apigee ワークスペースの作成、表示、管理を行う方法について説明します。

Apigee ワークスペースの作成

Apigee ワークスペースを作成するには:

次のいずれかの操作を行います。
- Apigee ワークスペースが現在表示されていない場合は、[Apigee] セクションで [Create Apigee workspace] をクリックします。
- [View] > [Command Palette] を選択して、コマンドパレットを開き、[Cloud Code: Create Apigee workspace] を選択します。
お好みの開発スタイルと一致するワークスペースの種類を選択します。単一リポジトリワークスペースまたはマルチリポジトリワークスペースを選択できます
Apigee ワークスペースの名前を入力します。
Apigee ワークスペースを保存するディレクトリに移動します。
ソースコントロール管理を使用している場合は、ソースコントロールリポジトリ内の場所を選択します。
[Select workspace folder] をクリックします。
Apigee ワークスペースが作成され、指定したローカルディレクトリに保存されて、VS Code Explorer で表示されます。
アクティビティバーの Cloud Code アイコンをクリックします。

次に示すように、Apigee ワークスペースが [Apigee] セクションに表示されます。

apiproxies、sharedflows、environments、tests を含む Apigee ワークスペースフォルダが表示されている Apigee Explorer。

選択したワークスペースのタイプに基づいて、次の内容が作成されます。

単一リポジトリワークスペースの場合、your-workspace-location の下に一連のフォルダが作成されます。詳細については、Apigee 単一リポジトリワークスペースの構造についてをご覧ください。
マルチリポジトリワークスペースの場合、必要な JSON コンテンツを含む your-workspace-location.code-workspace という名前のファイルが作成されます。詳細については、Apigee マルチリポジトリワークスペースの構造についてをご覧ください。

Apigee ワークスペースの表示

既存の Apigee ワークスペースを開くには:

次のいずれかの操作を行います。
- Apigee ワークスペースが現在開いていない場合は、Apigee Explorer の [Local development] ノードで [Open Apigee workspace] をクリックします。
- [View] > [Command Palette] を選択して、コマンドパレットを開き、[Cloud Code: Open Apigee Workspace] を選択します。
ローカル環境で Apigee ワークスペースに移動します。
- 単一リポジトリのワークスペースを開く場合は、src/main/apigee フォルダを含む Apigee ワークスペースの最上位フォルダを選択します。
- マルチリポジトリワークスペースを開く場合は、拡張子が .code-workspace のワークスペースファイルを選択します。
[Select workspace folder or multi-repository workspace file] をクリックします。
VS Code Explorer で Apigee ワークスペースが開き、ワークスペースの内容を確認できます。
アクティビティバーの Cloud Code アイコンをクリックします。

次に示すように、Apigee ワークスペースが Apigee Explorer に表示されます。

apiproxies、sharedflows、environments、tests を含む Apigee ワークスペースフォルダが表示されている Apigee Explorer。

Apigee 単一リポジトリワークスペースの構造について

Apigee VS Code で単一リポジトリの Apigee ワークスペースを作成すると、API プロキシと共有フローの開発、環境の構成とデプロイ、テストリソースの作成とエクスポートを行うための、一連のフォルダが作成されます。Apigee ワークスペースは、ローカル環境の your-workspace-folder/src/main/apigee に格納されます。

次の表に、Apigee ワークスペースの構造を大まかにまとめます。

フォルダ	説明
`apiproxies`	API プロキシの構成ごとに個別の `apiproxy-name/apiproxy` フォルダがあり、API プロキシ構成のディレクトリ構造に記載されているとおり構造化されています。例: `helloworld/apiproxy` 詳細については、API プロキシの開発をご覧ください。
`environments`	以下を含め、デプロイする API プロキシと共有フローのランタイム実行コンテキストを定義します。 API プロキシと共有フローのデプロイ定義環境レベルのリソース共有フローフックターゲットサーバーキーストア詳細については、環境の構成とデプロイをご覧ください。
`sharedflows`	共有フロー構成ごとに個別の `sharedflow-name/sharedflowbundle` フォルダがあり、共有フローバンドル構成のリファレンスに記載されているとおり構造化されています。例: `mysharedflow/sharedflowbundle` 詳細については、共有フローの開発をご覧ください。
`tests`	API プロダクトやデベロッパーなど、API をローカルでテストするために必要な一連のテストリソースを提供します。詳細については、テストリソースの構築とエクスポートをご覧ください。

次に、ローカル環境での Apigee ワークスペースの構造の例を示します。ここで、src/main/apigee はルートです。

Apigee ワークスペースの構造

Apigee マルチリポジトリワークスペースの構造について

マルチリポジトリワークスペースは、VS Code のマルチルートワークスペースと同様に機能します。ユーザーはアーティファクトの保存場所を個別に選択しながら、単一のワークスペースで開発作業を行うことができます。たとえば、プロキシごとに 1 つのソースコード管理リポジトリを使用したいこともあります。

マルチリポジトリワークスペースは、.code-workspace という拡張子の JSON テキストファイルです。

以下に、マルチリポジトリワークスペースの例を示します。ここには、2 つの API プロキシ（authentication-proxy、products-proxy）、1 つの共有フロー（SF-threat-protection）、2 つの環境（dev、test）、1 つのテストバンドル（test-products）が含まれています。

{
  "folders": [
    {
      "name": "authentication-proxy",
      "type": "proxy",
      "path": "/work/quickdemo/multi/authentication-proxy"
    },
    {
      "name": "products-proxy",
      "type": "proxy",
      "path": "/work/quickdemo/multi/products-proxy"
    },
    {
      "name": "SF-threat-protection",
      "type": "sharedflow",
      "path": "/work/quickdemo/multi/SF-threat-protection"
    },
    {
      "name": "dev",
      "type": "environment",
      "path": "/work/quickdemo/multi/dev"
    },
    {
      "name": "test",
      "type": "environment",
      "path": "/work/quickdemo/multi/test"
    },
    {
      "name": "test-products",
      "type": "test",
      "path": "/work/quickdemo/multi/test-products"
    }
  ]
}

マルチリポジトリワークスペースに追加できるフォルダには、次の要件があります。

フォルダの種類	必要なフォルダ構造
`environment`	環境の構成で説明されているように、環境の構成を定義します。フォルダの名前は環境の名前として使用されます。
`proxy`	API プロキシ構成のディレクトリ構造で説明されているように、API プロキシの構造を定義します。フォルダの名前が API プロキシの名前として使用されます。
`sharedflow`	共有フローバンドル構成のリファレンスで説明されている構造で共有フローを定義します。フォルダの名前が共有フローの名前として使用されます。
`test`	テストリソースの構築で説明されているように、一連のテストリソースを定義します。フォルダの名前がテストリソースの名前として使用されます。

Apigee マルチリポジトリワークスペースの編集

マルチリポジトリワークスペースを編集するには、VS Code または任意のエディタで your-workspace.code-workspace ファイルを開きます。

VS Code で Apigee 拡張機能からファイルを開くには:

Apigee Explorer の [Local development] ノードで [Edit workspace] をクリックします。
[View] > [Command Palette] を選択してコマンドパレットを開き、[Cloud Code: Edit Workspace] を選択します。

Apigee ワークスペースでのフォルダとファイルの管理

以降のセクションでは、Apigee ワークスペースのフォルダとファイルを管理する方法について説明します。

Apigee ワークスペースでのファイルの編集

Apigee ワークスペースでファイルを編集するには:

Apigee Explorer で、編集するファイルの名前をクリックします。エディタに内容が表示されます。
必要に応じてファイルを編集します。
[File] > [Save] を選択するか、または ⌘+S キーを押して、編集内容を保存します。

Apigee ワークスペースでのフォルダとファイルのコピー

Apigee ワークスペースでフォルダまたはファイルをコピーするには:

Apigee Explorer でコピーするフォルダまたはファイルを右クリックし、[Copy] を選択します。
フォルダまたはファイルの一意の名前を入力して、Enter キーを押します。

コピーされたフォルダまたはファイルが Apigee ワークスペースに表示されます。

Apigee ワークスペースでのフォルダとファイルの名前変更

Apigee ワークスペースでフォルダまたはファイルの名前を変更するには:

Apigee Explorer で、コピーするフォルダまたはファイルを右クリックし、[Rename] を選択します。
フォルダまたはファイルの一意の名前を入力して、Enter キーを押します。

Apigee Explorer で、フォルダまたはファイルの名前が変更されます。

Apigee ワークスペースからのフォルダとファイルの削除

Apigee ワークスペースからフォルダまたはファイルを削除するには、Apigee Explorer でコピーするフォルダまたはファイルを右クリックし、[Delete] を選択します。フォルダまたはファイルが Apigee ワークスペースから削除されます。

Apigee ワークスペースビューの更新

Apigee ワークスペースビューを更新して（VS Code の Apigee の外部で行われた可能性がある）最近の変更を同期するには、次のいずれかの操作を行います。

Apigee Explorer のタイトルバーにカーソルを合わせ、をクリックします。
[View] > [Command Palette] を選択してコマンドパレットを開き、[Cloud Code: Refresh Apigee Explorer view] を選択します。

次のステップ

API プロキシと共有フローの開発を開始する