管理 API 產品

查看 Apigee Edge 說明文件。
前往 Apigee X說明文件。 資訊

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

如需 API 產品總覽，請參閱 什麼是 API 產品？

探索 API 產品頁面

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

新增 API 產品

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

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

1. 如本節先前所述，請存取 API 產品頁面。
2. 按一下「+API 產品」。
3. 輸入 API 產品的「產品詳細資料」。
   

   欄位	說明
   名稱	API 產品的內部名稱。API 產品建立後即無法修改名稱。 請勿在名稱中指定特殊字元。
   顯示名稱	API 產品的顯示名稱。顯示名稱會用於 UI，您可以隨時編輯。如未指定，系統會使用名稱值。這個欄位會使用 Name 值自動填入；你可以編輯或刪除其中的內容顯示名稱可以包含特殊字元。
   說明	API 產品的說明。
   環境	API 產品允許存取的環境。例如 test 或 prod
   存取	存取層級。詳情請參閱「存取層級」。
   自動核准存取要求	啟用自動核准任何應用程式對這項 API 產品發出的金鑰要求。如要要求手動核准金鑰，請停用這個選項。詳情請參閱「註冊應用程式及管理 API 金鑰」(UI) 和「開發人員應用程式金鑰」(API)。
   配額	要參照配額政策的配額限制。輸入配額值並不會自動限制產品可發出的呼叫次數。產品所參照的 API Proxy 必須包含配額政策，才能強制執行配額。詳情請參閱配額一文。
   允許的 OAuth 範圍	如果您使用 OAuth 搭配 API 產品，則須允許 API 產品允許的 OAuth 範圍 (例如讀取，或應用程式會與 API 呼叫一起傳送的其他範圍)。使用逗號分隔清單指定多個範圍。請參閱 OAuth 範圍。

4. 新增 API 產品中提供的 API 資源，包括 API Proxy 和資源路徑。

   舉例來說，如果您新增了「音樂」API 產品可透過 API Proxy 導向基礎路徑為 /music 的產品，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 或 Path，還是同時新增 API Proxy 和路徑。

      

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

      注意事項：

      • 你定義的資源路徑會套用至新增至 API 產品的所有 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	是	否	否	否	否
/v1/weatherapikey/	是	否	否	否	否
/v1/weatherapikey/1	是	必要	是	否	否
/v1/weatherapikey/1/	是	必要	是	否	否
/v1/weatherapikey/1/2	是	否	是	否	否
/v1/weatherapikey/1/2/	是	否	是	是	否
/v1/weatherapikey/1/2/3/	是	否	是	必要	是
/v1/weatherapikey/1/a/2/3/	是	否	是	否	否

根據預設，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. 按一下「刪除」即可確認刪除作業。