建立 API Proxy

本頁適用於 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 說明文件。

。

請在 Apigee UI 中建立 Proxy，或使用 API 建立 Proxy，詳情請參閱下列各節。

API Proxy 主要欄位

建立 API Proxy 時，請遵循下列規範：

欄位 說明
API Proxy 名稱 顯示的 API 名稱。指定英數字元、連字號 (-) 或底線 (_)。
API Proxy 基礎路徑 API Proxy 的 http://[host] 或 https://[host] 位址後方顯示的 URI 片段。Apigee 會使用基礎路徑 URI 比對傳入的要求訊息，並將其轉送至適當的 API Proxy。

在基礎路徑中使用萬用字元

在 API Proxy 基礎路徑中使用一或多個萬用字元，以便在未來繼續使用 API Proxy。我們允許在兩個 / 正斜線字元之間指定單一 * 萬用字元：/*/。舉例來說，/team/*/members 的基本路徑可讓用戶端呼叫 https://[host]/team/blue/members 和 https://[host]/team/green/members，而您不必建立新的 API Proxy 來支援新的團隊。您可以按照這個模式，替換 basepath 中的任意符記數量。系統不支援其他模式，包括 /**、/something* 或 /*something。
說明 (選用) API Proxy 的說明。
目標/後端目標網址 這個 API Proxy 叫用的後端服務網址 (包括 HTTP 或 HTTPS)。
Space (選用) 如果貴機構已啟用 Apigee Spaces，您可以將 API Proxy 與 Space 建立關聯。 詳情請參閱 Apigee Spaces 總覽。

建立 API Proxy 的步驟

如要使用 UI 或 API 建立 API Proxy，請按照下列步驟操作：

Cloud 控制台中的 Apigee

如要在 Cloud 控制台中的 Apigee 中建立 Proxy，請按照下列步驟操作：

  1. 在瀏覽器中開啟 Cloud 控制台中的 Apigee UI。
  2. 在左側導覽窗格中，依序按一下「Proxy development」>「API Proxies」。
  3. 在「API Proxy」窗格中，按一下「+ 建立」。
  4. 在「Create a proxy」窗格中的「Proxy template」下方，選取「Reverse proxy (Most common)」。
  5. 在「Proxy details」下方輸入以下內容：
    • Proxy name：輸入 Proxy 的名稱，例如 myproxy。
    • Base Path：自動設為您為 Proxy name 輸入的值。「Base Path」是用於向 API 提出要求的網址的一部分。Apigee 會使用網址比對並將傳入的要求轉送至適當的 API Proxy。
    • 說明 (選填)：輸入新 API Proxy 的說明，例如「使用簡易 Proxy 測試 Apigee」。
    • 目標 (現有 API)：輸入 https://mocktarget.apigee.net。這會定義 Apigee 在對 API Proxy 提出要求時，要叫用的目標網址。mocktarget 服務由 Apigee 代管，並傳回簡單資料。不需要 API 金鑰或存取權杖。
    • 聊天室 (選用)：如果貴機構已啟用 Apigee 聊天室，您可以將 API Proxy 與從可用選項清單中選取的聊天室建立關聯。詳情請參閱 Apigee Spaces 總覽。
    • 點選「下一步」。
  6. 部署 (選用)：
    • 部署環境：選用。使用核取方塊選取一或多個要部署 Proxy 的環境。如果您不想在此時部署 Proxy，請將「部署環境」欄位留空。您之後隨時可以部署 Proxy。
    • 服務帳戶：選填。將服務帳戶附加至部署作業，讓 Proxy 能根據服務帳戶的角色和權限存取 Google Cloud 服務。
  7. 點選「建立」。

Apigee 會建立新的 Proxy，並在「Proxy summary」檢視畫面中顯示 Proxy 詳細資料的摘要。

myproxy 摘要窗格。

如果您選擇部署 Proxy，部署專區會顯示修訂版本編號，首次部署時為 1。「狀態」欄會顯示已部署 Proxy 的環境，並顯示綠色狀態指標。

傳統版 Apigee

如要在傳統 Apigee UI 中建立簡單的 API Proxy，請按照下列步驟操作：

  1. 登入 Apigee UI。
  2. 按一下主畫面中的「API Proxy」。
  3. 在「環境」下拉式清單中，選取要建立新 API 代理程式的環境。

    混合型 UI 會顯示該環境的 API Proxy 清單。如果您尚未建立任何 Proxy，清單會是空白的。

  4. 按一下「建立新項目」。

    「Create Proxy」(建立 Proxy) 精靈會隨即啟動。

  5. 按一下「Reverse proxy (most common)」(反向 Proxy，最常見)。

    反向 Proxy

    系統隨即會顯示「Proxy details」(Proxy 詳細資料) 頁面。

  6. 按照下列設定設定 Proxy：
    • 名稱：輸入 getstarted。如果已存在同名的 Proxy，請選擇其他名稱。
    • Base Path：請將此值設為 /getstarted。「Base Path」是用於向 API 提出要求的網址的一部分。Apigee 會使用網址比對並將傳入的要求轉送至適當的 API Proxy。
    • 說明 (選填)：輸入新 API Proxy 的說明，例如 Get started API proxy。
    • 目標 (現有 API)：輸入 https://mocktarget.apigee.net。這會定義 Apigee 在對 API Proxy 提出要求時，要叫用的目標網址。mocktarget 服務由 Apigee 代管，並傳回簡單資料。不需要 API 金鑰或存取權杖。

    API Proxy 的詳細資料應如下所示：

    API Proxy 詳細資料

  7. 點選「下一步」。
  8. 在「常見政策」檢視畫面中，選取「安全性：授權」下方的「傳送 (不授權)」。

    傳遞選取項目

  9. 點選「下一步」。
  10. 在「Summary」頁面上，視需要選取部署環境，然後按一下「Create and deploy」。

    建立及部署

    系統會建立新的 API Proxy，並在所選環境中部署。

    成功部署畫面

  11. 按一下「編輯 Proxy」，在 Proxy 編輯器中顯示「總覽」分頁。

    12. 編輯 Proxy 清單

在 API Proxy 清單中，getstarted 環境的 getstarted API Proxy 部署狀態為「綠色」。test

顯示 API Proxy 清單。getstarted 部署狀態為綠色。

Apigee API

請對下列資源發出 POST 要求，在 Apigee 機構中建立 API Proxy：

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 代理程式。

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。

後續步驟

建立簡單的 API Proxy 後，通常會執行下列任一操作：