管理 API 產品

您目前查看的是 Apigee Edge 說明文件。
前往 Apigee X 說明文件。 info

如本節所述，使用 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 產品的顯示名稱，顯示名稱會顯示在使用者介面中，而且隨時可以編輯。如未指定，系統會使用「名稱」值。系統會使用「名稱」值自動填入這個欄位，您可以編輯或刪除其內容。顯示名稱可以包含特殊字元。
   說明	API 產品說明。
   環境	API 產品允許存取的環境。例如 test 或 prod
   存取權	存取層級。詳情請參閱「存取層級」。
   自動核准存取要求	啟用這項設定後，系統會自動核准任何應用程式對這個 API 產品提出的金鑰要求。如要手動核准金鑰，請停用這項設定。請參閱「註冊應用程式及管理 API 金鑰」(使用者介面) 和「開發人員應用程式金鑰」(API)。
   配額	您要從配額政策參照的配額限制。輸入配額值不會自動限制透過產品撥打的通話次數。產品參照的 API Proxy 必須包含配額政策，才能強制執行配額。詳情請參閱配額的相關說明。
   允許的 OAuth 範圍	如果您搭配 API 產品使用 OAuth，請指定 API 產品允許的 OAuth 範圍 (例如「讀取」或其他應用程式在 API 呼叫中傳送的範圍)。以半形逗號分隔清單的形式指定多個範圍。請參閱「OAuth 範圍」。

4. 新增 API 產品中可用的 API 資源，包括 API 代理和資源路徑。

   舉例來說，如果將「music」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、路徑，還是同時新增 API Proxy 和路徑。

      

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

      注意事項：

      • 您定義的資源路徑會套用至 API 產品中新增的所有 API Proxy。
      • 較具包容性且較不明確的資源路徑，會優先於較明確的路徑。舉例來說，如果您同時新增 / 和 /**，系統會優先採用 / 資源路徑，並忽略 /** 資源路徑。

      例如：

      

   4. 按一下「新增」或「新增並開始另一項」 (指定其他 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 (已淘汰)，您可以使用 Raise Fault 政策擲回錯誤。

7. 按一下 [儲存]。

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

下表說明不同資源路徑的 API 產品預設行為。在本例中，API Proxy 的基本路徑為 /v1/weatherapikey。API 產品資源路徑適用於基本路徑後的路徑尾碼。

要求 URI	允許的管道：/	Allowed for /*	Allowed for /**	允許 /*/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 存取權杖。也就是說，遭撤銷的權杖在快取限制到期前，最多仍可成功使用三分鐘。
• 金鑰管理服務 (KMS) 實體 (應用程式、開發人員、API 產品)。
• OAuth 權杖和 KMS 實體的自訂屬性。

刪除 API 產品

如要刪除 API 產品，請先取消註冊/取消關聯與該產品相關聯的開發人員應用程式。 您可以刪除應用程式，或撤銷應用程式 API 金鑰。

如要刪除 API 產品，請按照下列步驟操作：

1. 如本節稍早所述，存取 API 產品頁面。
2. 將游標懸停在清單中的 API 產品上。
3. 按一下「」。
4. 按一下「刪除」確認刪除。