編輯 API Proxy (建立 Proxy 修訂版本)

本頁內容適用於 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 說明文件。

使用 Apigee UI 或 API 編輯 API Proxy。編輯 API Proxy 時，您可以決定如何處理產生的變更：

  1. 在伺服器上儲存變更，但不要建立新修訂版本。如果您不想部署已儲存的變更，但想確保變更不會在工作階段結束時遺失，就可以這麼做。

    OR

  2. 建立新的 API Proxy 修訂版本，並部署至叢集。您必須先建立 API Proxy 的新修訂版本，才能部署變更。

Cloud 控制台中的 Apigee

如要使用 Apigee Cloud 控制台編輯 API Proxy 並儲存變更，請按照下列步驟操作：

  1. 在 Google Cloud 控制台中，前往「Proxy development」(Proxy 開發) >「API proxies」(API Proxy) 頁面。

    前往 API Proxy

  2. 從 Proxy 清單中選取要編輯的 Proxy。 使用者介面會顯示 Google Cloud 控制台中該 Proxy 的「總覽」分頁。

    Proxy 編輯器中的「總覽」分頁
  3. 按一下「開發」分頁標籤。
  4. 您可以使用 Google Cloud 控制台變更 Proxy。完成變更後，您可以執行下列其中一項操作：
    • 如要儲存變更但不建立新修訂版本，請按一下「儲存」按鈕。(您應定期執行這項操作，確保結束工作階段時不會遺失變更)。
    • 如要將變更儲存為新修訂版本 (準備部署及測試時)，請按一下「儲存」按鈕旁的下拉式選單，然後選取「另存為新修訂版本」：

      在「儲存」選單中，將變更另存為新修訂版本。

      Apigee 使用者介面會儲存變更，並為您產生新的 Proxy 修訂版本。不會將新套件部署至執行階段，您必須明確執行這項操作，如「部署 API Proxy」一文所述。

傳統版 Apigee

如要使用傳統 Proxy 編輯器編輯 API Proxy 並儲存變更，請按照下列步驟操作：

  1. 登入 Apigee 使用者介面。
  2. 在主要檢視畫面中，按一下「API Proxy」。

    或者，您也可以在左側導覽選單中依序選取「Develop」>「API Proxies」。

  3. 選取要編輯的 Proxy 所在環境。

    Apigee 使用者介面會顯示所選環境的 API Proxy 清單：

    所選環境的 Proxy 清單。

  4. 按一下要編輯的 Proxy。使用者介面會顯示 Proxy 編輯器中該 Proxy 的「總覽」分頁：

    Proxy 編輯器中的「總覽」分頁。

  5. 按一下檢視畫面右上角的「開發」分頁標籤。
  6. 使用 Proxy 編輯器變更 Proxy。完成變更後，您可以執行下列其中一項操作：
    • 儲存變更，但不建立新修訂版本 (最常見；您應定期執行這項操作，確保在結束工作階段時不會遺失變更)。
    • 將變更儲存為新修訂版本 (準備部署及測試時)。
  7. 如要儲存但不建立新修訂版本，請點選使用者介面右上方的「儲存」：

    「儲存」按鈕。

    Apigee 使用者介面會儲存變更，方便您離開頁面，稍後再繼續作業。

  8. 如要將變更儲存為新修訂版本，請按一下「儲存」旁的下拉式箭頭，然後選取「另存為新修訂版本」：

    按一下「儲存為新修訂版本」

    Apigee 使用者介面會儲存變更，並為您產生新的 Proxy 套件。這不會將新套件部署至執行階段，您必須明確執行這項操作，如「部署 API 代理項目」一文所述。

    使用者介面會顯示「已儲存新的修訂版本」訊息：

    使用者介面會顯示「已儲存新修訂版本」訊息。

    建立新修訂版本後，您通常會將其部署至叢集，如「部署 API Proxy」一文所述。

Apigee API

編輯 API Proxy，在 Apigee 機構中建立修訂版本，方法是向下列資源發出 POST 要求：

https://apigee.googleapis.com/v1/organizations/$ORG/apis

您必須使用 name 查詢參數定義 API Proxy 的名稱。名稱只能使用下列字元：A-Za-z0-9._\-$ %

您也可以選擇匯入 API Proxy 設定組合，方法如下：

  • 將 action 查詢參數設為 import
  • 將 Content-type 標頭設為 multipart/form-data
  • 傳遞本機檔案系統中 API Proxy 設定套件的名稱

以下範例說明如何使用 API，匯入本機檔案系統中的 API Proxy 設定組合 (helloworld-config.zip)，藉此編輯 API Proxy。

export TOKEN=$(gcloud auth print-access-token)
export ORG=ORGANIZATION_NAME
curl "https://apigee.googleapis.com/v1/organizations/$ORG/apis?name=helloworld&action=import" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: multipart/form-data" \
  -F "file=@helloworld-config.zip"

其中 $TOKEN 會設為您的 OAuth 2.0 存取權杖，如「取得 OAuth 2.0 存取權杖」一文所述。如要瞭解本範例使用的 curl 選項，請參閱「使用 curl」。如要瞭解所用環境變數的說明，請參閱「設定 Apigee API 要求的環境變數」。

以下是回應輸出內容的範例：

{
  "basepaths": [
    "/helloworld"
  ],
  "configurationVersion": {
    "majorVersion": 4
  },
  "createdAt": "1559145292799",
  "displayName": "helloworld",
  "entityMetaDataAsProperties": {
    "bundle_type": "zip",
    "subType": "Proxy",
    "lastModifiedAt": "1559145292799",
    "createdAt": "1559145292799"
  },
  "lastModifiedAt": "1559145292799",
  "name": "helloworld",
  "policies": [
    "verify-api-key",
    "remove-query-param-apikey",
    "OAuth-v20-1"
  ],
  "proxies": [
    "default"
  ],
  "proxyEndpoints": [
    "default"
  ],
  "resourceFiles": {},
  "targetEndpoints": [
    "default"
  ],
  "targets": [
    "default"
  ],
  "type": "Application",
  "revision": "1",
  "description": "Hello world"
}

如要進一步瞭解如何編輯 API Proxy，請參閱 Apigee API 中的 apis.create 方法。如要查看 API Proxy 的所有可用方法，請參閱 API Proxy API。