步驟 7：部署至 Apigee 環境

本頁適用於 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 說明文件。

在 VS Code 中使用 Apigee 完成本機開發和測試後，您就可以將 API 部署為封存檔至 Apigee 環境。在這個步驟中，您將建立支援封存檔案部署的 Apigee 環境，並將 API Proxy 設定的封存檔案部署至 Apigee 環境。

  1. 請按照「建立環境」一文中的步驟操作，執行下列操作：
    1. 在 Apigee 機構中建立新的dev環境，並啟用Archive做為部署類型。使用使用者介面或API。

      例如：

      顯示「Archive」部署類型設定的新環境對話方塊

    2. 使用執行個體附件 API，將環境附加至執行階段執行個體。

      這個指令會觸發長期執行作業。請先確認環境已連結至執行階段，再繼續操作。

    3. 如果您尚未使用 Create environment groups API 建立環境群組，請建立一個。

      請先確認已建立環境群組再繼續操作。您可以使用以下要求查看新群組的狀態：

      curl -i -H "$AUTH" -H "Content-Type:application/json" \
  "https://apigee.googleapis.com/v1/organizations/$PROJECT_ID/environments/ENVIRONMENT_NAME"
    4. 使用環境群組附加 API，將新環境附加至環境群組。

      將環境連結至群組後，該環境中的 Proxy 就能透過群組中的主機名稱進行路由。這會觸發長時間執行的作業，可能需要幾分鐘才能完成。建議您稍候一兩分鐘，再繼續進行下一個步驟。在此期間，您可以如先前一樣查看作業狀態。

  2. 將 API Proxy 設定的封存檔部署至 Apigee 環境。
    1. 在 Apigee VS Code 的「Terminal」分頁中，前往「myapigeeworkspace」目錄。 
      cd myapigeeworkspace

      執行 ls 時，目錄應包含 src 資料夾。

    2. 執行下列指令： 
      gcloud beta apigee archives deploy --environment=dev --labels=release=052021

      以下提供回應範例：

      Using Apigee organization dev
Waiting for operation [b64c2665-b5ac-43cc-9e2d-232e8895c2ed] to complete...done
  3. 在「Terminal」分頁中執行下列指令，測試 API：
    curl https://INTERNAL_LOAD_BALANCER_IP/helloworld /
  -H "Host: ENV_GROUP_HOSTNAME"

    如要進一步瞭解這個範例中的變數，以及如何設定 API 存取權，請參閱「部署範例 Proxy」。

    系統會顯示以下錯誤訊息： 

    {"fault":{"faultstring":"Failed to resolve API Key variable request.queryparam.apikey",
  "detail":{"errorcode":"steps.oauth.v2.FailedToResolveAPIKey"}}}

    您必須建立包含 helloworld API 的 API 產品，然後使用 API 產品建立並註冊開發人員，才能取得 API 金鑰。

  4. 取得 API 金鑰。
    1. 使用 Apigee UI 建立 API 產品：
      1. 依序選取「發布」>「API 產品」。
      2. 點選「+ 建立」。
      3. 輸入 API 產品的產品詳細資料。
      4. 在欄位中輸入下列資訊：
        欄位 設定
        Name: myproduct
        Display name: myproduct
        Environment: dev
        Access: 公開
        Quota: 留空
        Allowed OAuth scope: 留空
      5. 在「操作」部分中，按一下「+ 新增操作」。
      6. 在「Source」下方，從「API Proxy」下拉式選單中選取「helloworld」。
      7. 在「Operation」下方的「Path」欄位中，輸入 /。

        將其他欄位設為預設值。

      8. 按一下「儲存」，即可儲存作業。
      9. 按一下「儲存」，即可儲存 API 產品。
    2. 在貴機構中建立開發人員：
      1. 在導覽選單中，依序選取「發布」>「開發人員」。
      2. 按一下「+ 開發人員」。
      3. 在欄位中輸入下列資訊：
        欄位 設定
        First Name: Alex
        Last Name: Hamilton
        Username: ahamilton
        Email: ahamilton@example.com
      4. 按一下 [建立]。
    3. 註冊應用程式：
      1. 依序選取「發布」>「應用程式」。
      2. 按一下「+ 應用程式」。
      3. 在欄位中輸入下列資訊：
        欄位 設定
        Name: myapp
        Display name: myapp
        Developer: ahamilton@example.com
        Callback URL: 留空
        Notes: 留空
        Expiry: 從不
        Product:
        1. 按一下「新增產品」。
        2. 選取「myproduct」。
        3. 按一下「新增」。
        Custom attributes: 留空
    4. 複製 API 金鑰。
      1. 在「應用程式」頁面 (「發布」>「應用程式」) 中，按一下「myapp」。
      2. 在 myapp 頁面上，按一下「憑證」部分中「金鑰」旁邊的「顯示」。請注意，API 金鑰與您建立的 API 產品相關聯。
      3. 選取並複製 API 金鑰。
  5. 再次執行 curl 呼叫，使用 apikey 查詢參數傳遞 API 金鑰，如下所示：
    curl -v https://$PUBLIC_FACING_IP/helloworld?apikey=ZQA5euYtNeJ7ZCGCJMpvd6F2BZOmxOzY

    系統會傳回以下回應：

    {
  "root": {
    "city": "San Jose",
    "firstName": "John",
    "lastName": "Doe",
    "state": "CA"
  }
}

恭喜！您已成功將 API 封存檔案部署至 Apigee 環境！

在下一個步驟中，您將將 API 封存檔推送至 Apigee 實際工作環境。

1 2 3 4 5 6 7 (NEXT) 步驟 8：將封存檔升級至正式環境