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

本頁適用於 ApigeeApigee Hybrid

查看 Apigee Edge 說明文件。

使用 Apigee UI 或 API 編輯 API Proxy。編輯 API Proxy 時,您可以決定要對產生的變更執行下列哪項操作:

  1. 將變更內容儲存至伺服器,但不要建立新的修訂版本。您會在不需要部署已儲存的變更,但只想確保在結束工作階段時不會遺失這些變更時,執行這項操作。

    OR

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

全新 Proxy 編輯器

如要使用新的 Proxy 編輯器編輯 API Proxy 並儲存變更,請按照下列步驟操作:

  1. 如果您使用的是 Cloud 控制台中的 Apigee UI:請依序選取「Proxy development」>「API Proxies」

    如果您使用的是傳統 Apigee UI:請依序選取「Develop」>「API Proxies」,然後在「Proxies」窗格中選取 Proxy 的環境。

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

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

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

      Apigee UI 會儲存變更內容,並為您產生新的 Proxy 修訂版本。它不會將新套件部署至執行階段;您必須明確執行此操作,如「部署 API Proxy」一文所述。

傳統 Proxy 編輯器

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

  1. 登入 Apigee UI
  2. 按一下主檢視畫面中的「API Proxy」

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

  3. 選取含有要編輯的 Proxy 的環境。

    Apigee UI 會顯示所選環境的 API Proxy 清單:

    所選環境的代理伺服器清單。

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

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

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

    「儲存」按鈕。

    Apigee UI 會儲存變更,讓您離開頁面後,稍後再繼續工作。

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

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

    Apigee UI 會儲存變更,並為您產生新的 Proxy 套件。不會將新套件部署至執行階段;您必須明確執行這項操作,如部署 API Proxy一文所述。

    UI 會顯示「New revision saved」訊息:

    使用者介面中顯示新修訂版本已儲存的訊息。

    建立新修訂版本後,通常會部署至叢集,如部署 API Proxy一文所述。

Apigee API

編輯 API Proxy,向下列資源發出 POST 要求,即可在 Apigee 機構中建立修訂版本:

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 代理程式設定套件 (helloworld-config.zip),藉此編輯 API 代理程式。

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 "[email protected]"

其中 $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