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