本頁內容適用於 Apigee 和 Apigee Hybrid。
查看
Apigee Edge 說明文件。
Apigee 可讓您使用政策�政策就像是實作特定管理功能的模組。 政策的設計宗旨是讓您輕鬆且可靠地為 API 新增常見的管理功能。政策提供安全防護機制、頻率限制、轉換和中介服務等功能,讓您不必自行編寫及維護這些功能。
您不限於使用 Apigee 提供的政策類型。您也可以編寫自訂指令碼和程式碼 (例如 JavaScript 應用程式),擴充 API Proxy 功能,並在 Apigee 政策支援的基本管理功能基礎上進行創新。
本主題將概略介紹 Apigee 中的政策類型和用途。如要瞭解特定政策,請參閱政策參考資料總覽。
政策類型和類別
從技術上來說,政策是 XML 格式的設定檔。每項政策的結構 (例如必要和選用的設定元素) 都是由 XML 結構定義。如果您熟悉 XML 工具,建議您在 GitHub 的 API Platform 範例中,瞭解政策結構定義。
Apigee 政策分為下列功能類別。如要查看各政策類別的適用政策,請參閱政策參考總覽。
流量管理
流量管理類別中的政策可讓您控管要求和回應訊息在 API Proxy 中的流動。這些政策支援作業和業務層級的控管。可讓您控管原始輸送量,也能以應用程式為單位控管流量。流量管理政策類型可讓您強制執行配額,也有助於防範阻斷服務攻擊。
安全性
安全類別的政策支援驗證、授權,以及以內容為基礎的安全防護。
中介服務
中介服務類別的政策可讓您在訊息流經 API Proxy 時,主動操控訊息。您可以透過這些轉換器,將訊息格式從 XML 轉換為 JSON (反之亦然),或是將一種 XML 格式轉換為另一種 XML 格式。您也可以使用這些閘道剖析郵件、產生新郵件,以及變更外寄郵件的值。中介服務政策也會與 Apigee 公開的基本服務互動,讓您在執行階段擷取應用程式、開發人員、安全權杖和 API 產品的相關資料。
擴充功能
擴充功能類別中的政策可讓您運用 Apigee 的擴充性,以所選程式設計語言實作自訂行為。
附加政策
如要將政策套用至 API Proxy,您必須在流程中將政策附加至 Proxy。 如需相關資訊,請參閱本節的其他主題,包括「透過使用者介面附加和設定政策」和「在 XML 檔案中附加及設定政策」。
部署政策變更
如要讓政策變更生效,您必須將 API Proxy 修訂版本部署至環境。 附加政策或變更現有政策後,請使用 Apigee UI 或 Apigee API 部署變更。
驗證政策執行
如要確認政策是否已正確強制執行,必須由 HTTP 用戶端叫用 API。如要驗證 Quota
設定,請設定配額 (例如每分鐘一個要求),然後向 API 提交多個要求,超過您在配額政策中設定的配額限制。(在下列要求中,URI 路徑已在 ProxyEndpoint 中設定為基本路徑設定,即 /weather
)。
http://ORG_NAME-test.apigee.net/weather/forecastrss?w=12797282
在一分鐘內提交多個要求後,您應該會看到下列錯誤訊息:
{ "fault":{ "faultstring":"policies.ratelimit.QuotaViolation", "detail":{ "errorcode":"policies.ratelimit.QuotaViolation" } } }
這表示 Apigee 正在強制執行 Quota
政策。
以政策為準的錯誤處理
請注意上方的錯誤訊息格式。其中包含 faultstring
屬性和 errorcode
屬性。在許多情況下,您需要實作一些行為來處理這些錯誤。舉例來說,如果開發人員的應用程式超出 Quota
,您可能想向他們發出自訂訊息。
如要進一步瞭解如何處理錯誤,請參閱「處理錯誤」。
最佳做法:常見的政策組合
為符合基本管理需求,API Proxy 通常會強制執行下列政策:
基本 API 金鑰驗證
ProxyEndpoint 要求流程:SpikeArrest
XMLThreatProtection
或JSONThreatProtection
- API 金鑰驗證
Quota
ResponseCache
ResponseCache
基本轉換:JSON 轉 XML
要求流程:SpikeArrest
JSONThreatProtection
- API 金鑰驗證
Quota
- JSONToXML
XMLToJSON
ResponseCache