管理 Apigee 工作區

本頁內容適用於 ApigeeApigee Hybrid

查看 Apigee Edge 說明文件。

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

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

建立 Apigee 工作區

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

  1. 執行下列其中一項動作:

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

      在使用者介面中建立 Apigee 工作區按鈕

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

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

  3. 輸入 Apigee 工作區名稱。

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

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

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

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

Apigee Explorer 顯示 Apigee 工作區資料夾,包括 apiproxies、sharedflows、environments 和 tests。

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

開啟 Apigee 工作區

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

  1. 執行下列其中一項動作:

    • 如果沒有開啟 Apigee 工作區,請點選 Apigee Explorer「本機開發」節點上的「開啟 Apigee 工作區」

      UI 中的「開啟 Apigee 工作區」按鈕

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

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

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

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

Apigee Explorer 會顯示 Apigee 工作區:

Apigee Explorer 顯示 Apigee 工作區資料夾,包括 apiproxies、sharedflows、environments 和 tests。

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

在 Apigee in Google Cloud中建立單一存放區 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」(Cloud Code:編輯工作區)

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

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

在 Apigee 工作區中編輯檔案

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

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

  2. 視需要編輯檔案。

  3. 選取「檔案」>「儲存」或按下 ⌘S,即可儲存編輯內容。

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

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

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

  2. 輸入資料夾或檔案的專屬名稱,然後按下 Enter 鍵。

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

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

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

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

  2. 輸入資料夾或檔案的專屬名稱,然後按下 Enter 鍵。

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

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

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

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

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

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

  • 選取「View」(檢視) >「Command Palette」(指令區塊面板),開啟指令區塊面板,然後選取「Cloud Code: Refresh Apigee Explorer view」(Cloud Code:重新整理 Apigee Explorer 檢視畫面)