管理 Apigee 工作區

本頁適用於 ApigeeApigee Hybrid

查看 Apigee Edge 說明文件。

您必須在 Cloud Code 中建立新的 Apigee 工作區或開啟現有工作區,才能在本機使用 Cloud Code 開發 Apigee API。Apigee 工作區包含本機開發作業所需的目錄結構。

以下各節將說明如何建立、開啟及管理 Apigee 工作區。

建立 Apigee 工作區

如要建立 Apigee 工作區,請按照下列步驟操作:

  1. 執行下列任一操作:

    • 如果沒有開啟 Apigee 工作區,請在「Apigee」專區中按一下「建立 Apigee 工作區」

      在 UI 中建立 Apigee 工作區按鈕

    • 依序選取「View」>「Command Palette」開啟指令面板,然後選取「Cloud Code: Create Apigee workspace」

  2. 選取符合您偏好開發風格的工作區類型。您可以選擇單一存放區工作區多個存放區工作區

  3. 輸入 Apigee 工作區的名稱。

  4. 前往要儲存 Apigee 工作區的目錄。如果您使用原始碼控管,請在原始碼控管存放區中選取位置。

  5. 按一下「選取工作區資料夾」。Apigee 工作區會建立並儲存在指定的本機目錄中,並在 VS Code Explorer 中開啟。

  6. 按一下活動列中的 Cloud Code 中的 Apigee 圖示「Cloud Code」圖示。

Apigee 工作區會顯示在「Apigee」Apigee部分:

Apigee Explorer 顯示 Apigee 工作區資料夾,包括 API 代理程式、共用流程、環境和測試。

系統會根據所選工作區類型建立下列內容:

開啟 Apigee 工作區

如要開啟現有的 Apigee 工作區,請按照下列步驟操作:

  1. 執行下列任一操作:

    • 如果沒有開啟 Apigee 工作區,請在 Apigee Explorer 的「Local development」節點上按一下「Open Apigee workspace」

      在 UI 中開啟 Apigee 工作區按鈕

    • 依序選取「View」>「Command Palette」開啟指令區塊面板,然後選取「Cloud Code: Open Apigee Workspace」

  2. 前往本機環境中的 Apigee 工作區。

    • 如果您要開啟單一存放區工作區,請選取 Apigee 工作區的頂層資料夾,該資料夾包含 src/main/apigee 資料夾。
    • 如果您要開啟多存放區工作區,請選取副檔名為 .code-workspace 的工作區檔案。
  3. 按一下「選取工作區資料夾或多存放區工作區檔案」。Apigee 工作區會在 Cloud Code 中開啟,您可以在其中瀏覽工作區內容。

  4. 按一下活動列中的 Cloud Code 中的 Apigee 圖示「Cloud Code」圖示。

Apigee Explorer 會顯示 Apigee 工作區:

Apigee Explorer 顯示 Apigee 工作區資料夾,包括 API 代理程式、共用流程、環境和測試。

瞭解 Apigee 單一存放區工作區的結構

在 Google Cloud中,如果您在 Apigee 中建立單一存放區 Apigee 工作區,系統會建立一組資料夾,方便您開發 API Proxy 和共用流程、設定及部署環境,以及建構及匯出測試資源。Apigee 工作區會儲存在本機環境的 your-workspace-folder/src/main/apigee 中。

下表概略說明 Apigee 工作區的結構。

資料夾 說明
apiproxies 包含每個 API Proxy 設定的獨立 apiproxy-name/apiproxy 資料夾,其結構如「API Proxy 設定目錄結構」一節所述。

例如:helloworld/apiproxy

詳情請參閱「開發 API Proxy」。

environments 定義要部署的 API Proxy 和共用流程的執行階段執行情境,包括:
  • API Proxy 和共用流程部署定義
  • 環境層級資源
  • 共用流程掛鉤
  • 目標伺服器
  • 主要商店

詳情請參閱「設定及部署環境」。

sharedflows 包含每個共用流程設定的個別 sharedflow-name/sharedflowbundle 資料夾,其結構如「共用流程組合設定參考資料」一節所述。

例如:mysharedflow/sharedflowbundle

詳情請參閱「開發共用流程」。

tests 提供一組測試資源,例如 API 產品或開發人員,以便在本機測試 API。

詳情請參閱「建構及匯出測試資源」。

請參閱本機環境中 Apigee 工作區結構的範例,其中 src/main/apigee 是根目錄:

Cloud Code 中的 Apigee 工作區結構

瞭解 Apigee 多存放區工作區的結構

多存放區工作區的運作方式與 Cloud Code 中的多根工作區類似。使用者可以彈性地為成果選擇個別儲存位置,但仍可使用單一工作區一併開發成果。例如,使用者偏好每個 Proxy 都有一個原始碼管理存放區。

多存放區工作區是具有 .code-workspace 副檔名的 JSON 文字檔案。

以下是多個存放區工作區的範例內容,其中包含兩個 API 代理程式 (authentication-proxy、products-proxy)、一個共用流程 (SF-threat-protection)、兩個環境 (dev、test) 和一個測試套件 (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 Proxy 結構,如「API Proxy 設定目錄結構」一文所述。系統會使用資料夾名稱做為 API Proxy 的名稱。
sharedflow 如「共用流程組合設定參考資料」所述,定義共用流程結構。系統會使用資料夾名稱做為共用流程的名稱。
test 定義一組測試資源,如「建構測試資源」一文所述。資料夾名稱會用做測試資源名稱。

編輯 Apigee 多存放區工作區

在 Cloud Code 或您慣用的編輯器中開啟 your-workspace.code-workspace 檔案,即可編輯多存放區工作區。

如要在 Cloud Code 中的 Apigee 擴充功能中開啟檔案,請按照下列步驟操作:

  • 在 Apigee Explorer 的「Local development」節點上,按一下「Edit workspace」

    在 UI 中開啟 Apigee 工作區按鈕

  • 依序選取「View」>「Command Palette」開啟指令面板,然後選取「Cloud Code: Edit Workspace」

管理 Apigee 工作區中的資料夾和檔案

以下各節說明如何管理 Apigee 工作區中的資料夾和檔案。

在 Apigee 工作區中編輯檔案

如要在 Apigee 工作區中編輯檔案,請按照下列步驟操作:

  1. 在 Apigee Explorer 中,按一下要編輯的檔案名稱。內容會顯示在編輯器中。

  2. 視需要編輯檔案。

  3. 選取「File」>「Save」或按下 ⌘S 鍵即可儲存編輯內容。

複製 Apigee 工作區中的資料夾和檔案

如要在 Apigee 工作區中複製資料夾或檔案,請按照下列步驟操作:

  1. 在 Apigee Explorer 中找出要複製的資料夾或檔案,然後按一下滑鼠右鍵,並選取「複製」

  2. 為資料夾或檔案輸入不重複的名稱,然後按下 Enter 鍵。

複製的資料夾或檔案會顯示在 Apigee 工作區中。

在 Apigee 工作區中重新命名資料夾和檔案

如要在 Apigee 工作區中重新命名資料夾或檔案,請按照下列步驟操作:

  1. 在 Apigee Explorer 中找出要複製的資料夾或檔案,然後按一下滑鼠右鍵,並選取「Rename」

  2. 為資料夾或檔案輸入不重複的名稱,然後按下 Enter 鍵。

資料夾或檔案會在 Apigee Explorer 中重新命名。

從 Apigee 工作區刪除資料夾和檔案

如要從 Apigee 工作區刪除資料夾或檔案,請在 Apigee Explorer 中按一下要複製的資料夾或檔案,然後選取「Delete」。資料夾或檔案會從 Apigee 工作區中移除。

重新整理 Apigee 工作區檢視畫面

如要重新整理 Apigee 工作區檢視畫面,並同步處理最近 (可能在 Cloud Code 之外) 所做的變更,請執行下列任一操作:

  • 將滑鼠游標移至 Apigee Explorer 標題列,然後按一下 Apigee Explorer 的重新整理圖示

  • 依序選取「View」>「Command Palette」開啟指令面板,然後選取「Cloud Code: Refresh Apigee Explorer view」