管理 API 產品

您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件
資訊

按照本節所述,使用 Apigee Edge 管理 UI 管理 API 產品。如要使用 API 管理 API 產品,請參閱使用 Edge Management API 發布 API

請觀看以下影片,瞭解如何建立 API 產品。

如需 API 產品總覽,請參閱「什麼是 API 產品?」一文。

探索 API 產品頁面

按照下文說明存取 API 產品頁面。

Edge

如何使用 Edge UI 存取 API 產品頁面:

  1. 登入 https://apigee.com/edge
  2. 依序選取「發布」>「API 產品」

系統隨即會顯示「API 產品」頁面。

顯示 API 產品清單的 API 產品頁面。摘要會顯示可完成的任務,如圖表下方。

如上圖所示,API 產品頁面可讓您執行下列工作 (詳情請參閱本節後續內容):

傳統邊緣 (Private Cloud)

如何使用傳統版 Edge UI 存取 API 產品頁面:

  1. 登入 http://ms-ip:9000,其中 ms-ip 是管理伺服器節點的 IP 位址或 DNS 名稱。
  2. 依序選取「發布」>「產品」

API 產品頁面可讓您執行下列工作 (本節後段說明):

新增 API 產品

按照下文說明透過 UI 新增 API 產品。如要使用 Edge API,請參閱使用 API 設定 API 產品

如何使用 Edge UI 新增 API 產品:

  1. 如本節前所述,存取 API 產品頁面
  2. 按一下「+API 產品」
  3. 輸入 API 產品的產品詳細資料。
    欄位 說明
    名稱 API 產品的內部名稱。API 產品建立後即無法編輯名稱。請勿在名稱中指定特殊字元。
    顯示名稱 API 產品的顯示名稱。UI 會使用這個顯示名稱,您可以隨時編輯。如未指定,系統會使用「Name」值。這個欄位會自動填入「名稱」值,您可以編輯或刪除其中的內容。顯示名稱可包含特殊字元。
    說明 API 產品的說明。
    環境 API 產品允許存取的環境。例如 testprod
    存取權 存取層級。詳情請參閱「存取層級」。
    自動核准存取要求 啟用自動核准從任何應用程式對這個 API 產品發出的金鑰要求。如要要求手動核准金鑰,請停用這個選項。請參閱「註冊應用程式及管理 API 金鑰」(UI) 和「開發人員應用程式金鑰」(API)。
    配額 您想從配額政策參照的配額限制。輸入配額值並不會自動限制產品可發出的呼叫次數。產品參照的 API Proxy 必須納入配額政策,才能強制執行配額。詳情請參閱配額
    允許的 OAuth 範圍 如果您將 OAuth 與 API 產品搭配使用,請輸入您希望 API 產品允許的 OAuth 範圍 (例如應用程式隨 API 呼叫傳送的讀取範圍或其他範圍)。使用以逗號分隔的清單指定多個範圍。請參閱 OAuth 範圍
  4. 新增 API 產品中提供的 API 資源,包括 API Proxy 和資源路徑。

    舉例來說,如果您使用 /music 的基本路徑為產品新增「音樂」API Proxy,則 API 產品可以允許呼叫 /music。不過,如果您想讓 API 產品只允許存取 venues 資源路徑 ( URI 為 /music/venues),請將 /venues 資源路徑新增至該產品。在此情況下,允許呼叫 /music/venues?name=paramount,但會封鎖對 /music/artists?name=Jack%Johnson 的呼叫。

    只要將資源路徑指定為 /,即可設定特定資源路徑,或是設定基本路徑和所有可能的子路徑。資源路徑可包含萬用字元 /**/*。雙星號萬用字元表示支援基本路徑的所有子路徑,但不支援基本路徑。一個星號表示系統僅支援基礎路徑下一層的 URI。請參閱本節下方的設定「/」、「/*」和「/**」資源路徑的行為

    如何新增 API 資源:

    1. 按一下「API 資源」部分的「新增 Proxy」或「新增路徑」
    2. 選擇是否要新增「API Proxy」、「路徑」,或一併新增 API Proxy 和路徑

      「新增 API 資源」區段可讓您新增 API Proxy 和/或資源路徑。

    3. 新增一或多個 API Proxy 和資源路徑。

      請注意:

      • 您定義的資源路徑會套用至新增至 API 產品的所有 API Proxy。
      • 系統會優先顯示較多元、較不明確的資源路徑,而非較具體的資源路徑。舉例來說,如果您新增 //**,系統會優先採用 / 資源路徑,並忽略 /** 資源路徑。

      例如:

      套用至所有 API Proxy 的資源路徑,並忽略更明確的資源路徑

    4. 按一下「Add」或「Add and Start another」 (指定其他 API 資源)。
  5. (選用) 使用 Apigee 遠端服務目標區段,將產品繫結至一或多個遠端服務目標。除非您使用的是 Apigee Envoy 轉接器,否則您可以忽略這項設定。 詳情請參閱 Apigee Envoy 轉接器的作業指南
  6. (選用) 您可以使用「自訂屬性」專區為 API 產品新增最多 18 個自訂屬性。

    自訂屬性是可用於多種方式的鍵/值組合,包括協助控制 API Proxy 執行作業。舉例來說,您可以建立一個名為 deprecated 的自訂屬性,並將值設為 true 或 false。在 API Proxy 流程中,您可以查看 API 產品的 deprecated 屬性值,例如使用在您建立自訂屬性後系統自動提供的 verifyapikey.{policy_name}.apiproduct.deprecated 變數。如果值為 true (已淘汰),您可以透過「調高錯誤」政策擲回錯誤。

  7. 點按「儲存」

設定「/」、「/*」和「/**」資源路徑的行為

下表說明 API 產品在不同資源路徑的預設行為。在這個範例中,API Proxy 的基本路徑為 /v1/weatherapikey。API 產品資源路徑會套用至基本路徑後方的路徑後置字串。

請求 URI 允許範圍: 允許金額 /* 允許範圍:/** 允許 /*/2/** 允許 /*/2/*

/v1/weatherapikey

必要

N

N

N

N

/v1/weatherapikey/

必要

N

N

N

N

/v1/weatherapikey/1

必要

必要

N

N

/v1/weatherapikey/1/

必要

必要

N

N

/v1/weatherapikey/1/2

必要

N

N

/v1/weatherapikey/1/2/

必要

Y

N

/v1/weatherapikey/1/2/3/

必要

Y

必要

必要

/v1/weatherapikey/1/a/2/3/

必要

N

N

根據預設,API 產品中的 / 資源路徑支援基本路徑和所有子路徑。舉例來說,如果 API Proxy 的基本路徑為 /v1/weatherapikey,則 API 產品支援傳送至 /v1/weatherapikey 和任何子路徑 (例如 /v1/weatherapikey/forecastrss/v1/weatherapikey/region/CA 等) 的要求。

您可以變更這項預設值,讓 / 的資源路徑只對應 API Proxy 的基本路徑,也就是說,API 產品不允許存取 / 之後的任何 URI。如果您進行這項變更,在上表中,「允許用於/」的前兩列只有「Y」。

如要變更預設值,系統管理員必須將貴機構的 features.isSingleForwardSlashBlockingEnabled 屬性值設為 true。Cloud 客戶可以向 Apigee Edge 支援團隊提出要求。

編輯 API 產品

如何編輯 API 產品:

  1. 如本節前所述,存取 API 產品頁面
  2. 找出要編輯的 API 產品,然後按一下該產品列。
  3. 按一下 API 產品頁面上的「編輯」
  4. 視需要編輯欄位。

    您可以刪除已新增至 API 產品的資源。如果資源故障或需要進一步開發,建議採用這項操作。刪除後,該項資源不再是 API 產品的一部分。凡是使用這項 API 產品的應用程式,都無法再存取已刪除的資源。已刪除的資源會從產品中移除,但不會從系統中刪除,因此其他產品仍可使用。

  5. 點按「儲存」

有了 Apigee Edge for Public Cloud,Edge 能在存取實體後,將下列實體保留在快取中至少 180 秒。

  • OAuth 存取權杖。這表示撤銷的權杖可能仍有最多三分鐘的成功,直到快取限製到期為止。
  • Key Management Service (KMS) 實體 (應用程式、開發人員、API 產品)。
  • OAuth 權杖和 KMS 實體的自訂屬性。

刪除 API 產品

刪除 API 產品前,您必須先取消註冊/取消連結任何與該產品相關聯的開發人員應用程式。 您可以刪除應用程式撤銷應用程式 API 金鑰

刪除 API 產品的步驟如下:

  1. 如本節前所述,存取 API 產品頁面
  2. 將遊標移到清單中的 API 產品上。
  3. 按一下「刪除圖示」。
  4. 按一下「刪除」來確認刪除作業。