本頁適用於 Apigee 和 Apigee Hybrid。
查看
Apigee Edge 說明文件。
API 產品會將您的 API 打包，供應用程式開發人員使用。如要瞭解 API 產品的總覽，請參閱「什麼是 API 產品？」。
探索 API 產品總覽頁面
「產品」總覽頁面會顯示所有 API 產品，以及每項產品的部分詳細資料。您可以在這個頁面建立新的 API 產品、刪除產品，或選取要查看或編輯的產品。
如要在 Apigee in Cloud 控制台中存取「產品」總覽頁面，請按照下列步驟操作：
您可以透過「產品」使用者介面執行下列常見工作：
我們會在下文中逐一說明。
建立 API 產品
本節說明如何使用 Apigee UI 建立 API 產品。
如要使用 Apigee UI 建立 API 產品，請按照下列步驟操作：
前往「產品」總覽頁面：
- 按一下「+ 建立」。產品設定頁面隨即顯示。
- 設定 API 產品。產品設定頁面的部分內容包括：
- 產品詳細資料：API 產品的基本資訊，例如名稱、存取層級 (私人、公開或內部) 和 OAuth 範圍。
- 作業：這個 API 產品支援的 API 代理程式、資源路徑和 HTTP 方法群組。您也可以為每項作業定義配額限制。
- GraphQL 作業： 這個 API 產品支援的 API Proxy、資源路徑和 GraphQL 作業類型群組。支援的 GraphQL 運算類型包括查詢和異動。您可以指定其中一種或兩種類型。就像以 REST 為基礎的 API Proxy 一樣，您可以為每項作業定義配額限制。
- gRPC 作業： 指定此 API 產品支援的 gRPC API 代理程式和 gRPC 方法。就像是針對以 REST 為基礎的 API Proxy 一樣，您可以為作業定義配額限制。
- 自訂屬性：鍵/值組合，可協助您控制 API Proxy 執行作業。
下列各節將分別說明這些主要部分。
- 完成後，請按一下「儲存」。Apigee 會建立新的 API 產品。您現在可以將產品附加至開發人員應用程式。請參閱「註冊應用程式來控管 API 存取權」。如需其他範例，請參閱「要求使用者提供 API 金鑰來保護 API」和「使用 OAuth 保護 API」。
產品詳細資料
在「產品詳細資料」部分，輸入新 API 產品的基本資訊。下表說明這個部分的欄位：
| 欄位 | 是否必要 | 說明 |
|---|---|---|
Name |
必填 |
定義 API 產品的內部名稱。您可以在參照 API 產品的 Apigee API 呼叫中使用這個值。 例如 |
Display name |
必填 |
定義 Apigee UI 中 API 產品使用的名稱。您隨時可以編輯 API 產品的顯示名稱。
例如 |
Description |
選用 |
這個字串可協助您記住 API 產品的用途或功能。說明可包含特殊字元。 例如 |
Space |
選用 |
如果貴組織已啟用 Apigee Spaces，您可以將 API 產品與從可用選項清單中選取的 Space 建立關聯。詳情請參閱 Apigee Spaces 總覽。 |
Environment |
選用 |
指出 API 產品允許存取哪些環境。如果未指定環境，API 產品就會允許所有環境。 您在這欄中選取的環境會根據 API 代理程式部署位置限制對 API 代理程式的存取權。舉例來說，如果 API 代理程式 A 同時部署至 |
Access |
必填 | 授予此 API 產品使用者的存取層級。詳情請參閱存取層級。 |
Automatically approve access requests |
選用 (預設為已選取) |
啟用自動核准功能，針對任何應用程式傳送至此 API 產品的金鑰要求進行核准。如需手動核准金鑰，請停用這個選項。 系統會選取預設值，表示這個 API 產品會自動核准金鑰要求。 如果您選取手動金鑰核准，則必須核准來自任何使用此 API 產品的應用程式的金鑰要求。如何手動核准金鑰：
詳情請參閱「註冊應用程式和管理 API 金鑰」。 |
Quota |
選用 |
定義此 API 產品允許的要求數量上限。這個值適用於此 API 產品的所有作業要求總和。 此值會由您在 API 產品中定義的作業所設的更具體配額限制取代。 輸入配額值不會自動限制可透過 API 產品發出的呼叫次數。您也必須將配額政策新增至 API 產品參照的 API Proxy。 詳情請參閱「配額」。 |
Allowed OAuth scope |
選用 | 如果您要將 OAuth 與 API 產品搭配使用，請輸入以半形逗號分隔的 OAuth 範圍清單，並指定要讓 API 產品允許的範圍 (例如「Read」或其他應用程式透過 API 呼叫傳送的範圍)。詳情請參閱「OAuth 範圍」。 |
作業
指定在以 HTTP 為基礎的 API 代理程式上允許的作業，包括資源路徑、HTTP 方法和配額。透過操作，您可以控制哪些 REST 方法和資源路徑可供 API 產品存取，以及可以發出多少此類呼叫 (使用配額)。
如要設定作業詳細資料，請在「作業」部分中按一下「+ 新增作業」。系統會顯示「Operation」檢視畫面。
| 欄位 | 是否必要 | 說明 |
|---|---|---|
API proxy |
必填 |
選取要與此作業建立關聯的 API 代理程式。 |
Path |
必填 |
輸入作業的資源路徑。 您可以使用作業路徑，允許或禁止對特定 URI 的請求。舉例來說，如果您將作業來源設為 在這種情況下，系統會允許對 請注意，資源路徑中的萬用字元有特殊規則，如「設定資源路徑」一文所述。 |
Methods |
選用 |
在下拉式清單中選取一或多個 HTTP 要求方法。(這些方法有時也稱為 HTTP 動詞)。Apigee 只允許與您選取的方法相符的 API proxy 要求。 預設值為未選取，允許使用任何 HTTP 方法的要求。 如果您未選取至少一種方法，Apigee 會在您儲存作業時，將 如要瞭解 HTTP 要求方法的功能，請參閱 HTTP 要求方法。 |
Quota |
選用 | 指定這項作業的配額限制。如要進一步瞭解如何計算配額，請參閱「瞭解配額計數器」。 |
Custom attributes |
選用 | 請參閱「自訂屬性」。 |
GraphQL 作業
如要設定 GraphQL 作業詳細資料，請按一下「Graphql 作業」專區中的「+ 新增作業」。系統會顯示「Operation」檢視畫面。另請參閱「使用 GraphQL」。
| 欄位 | 是否必要 | 說明 |
|---|---|---|
API proxy |
必填 |
選取要與此作業建立關聯的 API 代理程式。 |
Operation name |
必填 |
指定作業名稱 |
Operation type |
選用 |
在下拉式清單中選取一或多個 GraphQL 運算類型。Apigee 只允許與您選取的運作類型相符的 API Proxy 要求。 預設值為未選取，允許使用任何作業類型的要求。 如果您未選取至少一種類型，Apigee 會在您儲存作業時，將 如要瞭解 GraphQL 作業類型的功能，請參閱「查詢和變異」。 |
Quota |
選用 | 指定這項作業的配額限制。這個配額會取代 API 產品設定的配額。請參閱「配額」一文。 |
Custom attributes |
選用 | 請參閱「自訂屬性」。 |
gRPC 作業
如要設定 gRPC 作業詳細資料，請在「gRPC 作業」部分中按一下「+ 新增作業」。系統會顯示「Operation」檢視畫面。另請參閱「建立 gRPC API Proxy」。
| 欄位 | 是否必要 | 說明 |
|---|---|---|
API proxy |
必填 |
選取要與此作業建立關聯的 API 代理程式。 |
Service name |
必填 |
指定作業名稱。 在目前版本中，您無法提供目標伺服器名稱。(服務名稱和目標伺服器相同)。 |
gRPC methods in service |
選用 |
輸入可用的 gRPC 方法，並以半形逗號分隔多個方法。 |
Quota |
選用 | 指定這些作業的配額限制。這個配額會取代 API 產品設定的配額。請參閱「配額」一文。 |
Custom attributes |
選用 | 請參閱「自訂屬性」。 |
自訂屬性
自訂屬性是鍵/值組合，可用於多種用途，包括協助控制 API Proxy 執行作業。
API 產品最多可包含 18 個自訂屬性，包括在作業中設定的屬性。
舉例來說，您可以建立名為 deprecated 的自訂屬性，其值為 true 或 false。在 API Proxy 流程中，您可以查看 API 產品的 deprecated 屬性值。如果其值為 true，您可以使用 RaiseFault 政策擲回錯誤，因為您希望該作業的行為就像已淘汰且不再支援的操作一樣。
配額
定義 API 代理程式或作業範圍的配額設定。如果您定義配額，則必須指定 Quota 下方的三個欄位：
第一個欄位會指定在指定期間內，允許開發人員應用程式向 API Proxy 發出的要求數量上限。
這個欄位對應到配額政策中的
<Allow>元素。第二個欄位則指定配額的重設頻率 (或間隔)。
這個欄位對應到配額政策中的
<Interval>元素。第三個欄位會指定重設週期類型 (或時間單位)，例如天、週或月。
這個欄位對應到配額政策中的
<TimeUnit>元素。
以下範例會將 API Proxy 的每日 GET、HEAD 和 TRACE 要求數量上限設為 1,000 (所有其他 HTTP 要求都會遭到忽略)：
以下範例會將 /mypath 資源的限制設為每 3 分鐘 42 個要求，不論 HTTP 方法為何皆適用：
定義作業配額時，您必須在「配額」部分輸入三個欄位的值。
您無法為同一個作業的多個 HTTP 方法定義不同的配額。如要這麼做，您必須建立多個 API 產品，並為每個產品定義方法專屬配額。
如果您在配額政策和 API 產品 (在 UI 中或使用 API 產品 API) 中都設定這些值，則 API 產品 UI/API 設定會優先採用。
設定資源路徑
請注意下列資源路徑規則：
/：表示系統支援基本路徑和基本路徑的所有子路徑。/**：表示系統支援基本路徑的所有子路徑 (但不包括基本路徑)。/*：表示僅支援從基準路徑向下一個層級的 URI。- 在 API 產品或其作業中指定的資源路徑，會套用至新增至 API 產品的所有 API 代理程式。
- 較具包容性且較具體的資源路徑，優先於較具體的資源路徑。舉例來說，如果您新增
/和/**，系統會優先採用/資源路徑，並忽略/**資源路徑。
下表列出 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 產品設定」。
編輯 API 產品
如要編輯 API 產品，請按照下列步驟操作：
前往「產品」總覽頁面：
- 按一下要編輯的 API 產品列。Apigee 會顯示 API 產品詳細資料。
- 點選「編輯」圖示 。
-
視需要編輯 API 產品的設定。
您無法編輯現有的 API 資源。如要變更 API 資源，您必須先刪除該資源，然後再新增含有修正值的新版本。
如果資源發生故障或需要更多開發作業，您可以刪除該資源。刪除後，該資源就不再屬於目前的 API 產品。任何使用 API 產品的應用程式都無法再存取已刪除的資源。刪除的資源會從 API 產品中移除，但不會從系統中刪除，因此其他 API 產品仍可使用這些資源。
- (選用) 如果已啟用 Apigee Monetization，請按一下「Add rate plan」或
(傳統 UI)，為 API 產品建立費率方案。 -
按一下 [儲存]。
變更會在短時間內 (約五分鐘) 生效。
刪除 API 產品
如要刪除 API 產品，您必須先取消註冊/取消關聯與產品相關聯的所有開發人員應用程式。 您可以刪除應用程式或撤銷應用程式 API 金鑰。
如要刪除 API 產品，請按照下列步驟操作：
前往「產品」總覽頁面：
- 開啟 API 產品列中的「動作」選單，然後選取「刪除」。
- 確認刪除作業後，刪除作業會在短時間內 (約五分鐘) 生效。