基本術語

您正在查看 Apigee Edge 說明文件。
前往 Apigee X 說明文件
info

在 Apigee 中,有幾個概念是常見概念,但具有特殊含義。

字詞 定義
API

應用程式設計介面:可讓一個應用程式輕鬆使用其他應用程式的功能或資料的介面。

透過定義應用程式邏輯和資料的穩定簡化進入點,API 可讓開發人員輕鬆存取及重複使用其他開發人員建構的應用程式邏輯。在 Web API 的情況下,該邏輯和資料會透過網路公開。由於使用 API 的應用程式對變更十分敏感,因此 API 也暗示了合約。這份合約可提供一定程度的保證,讓您知道 API 會以可預測的方式隨時間變更。

Apigee 提供豐富的 API 相關資訊,以及開發及使用 API 的最佳做法。如要開始使用,請參閱 API 設計網路廣播節目,或下載免費的電子書 Web API Design:The Missing Link Best Practices for Crafting Interfaces that Developers Love

API Proxy

Edge 上針對一或多個 API、一般 HTTP 服務或應用程式 (例如 Node.js) 的門面。

API Proxy 是以一組設定檔、政策和程式碼的形式實作,這些元素會依賴 Apigee Edge 提供的一組資源。您可以使用 Apigee Edge 管理使用者介面產生及設定 API Proxy,也可以在本機的文字編輯器或 IDE 中實作。

API Proxy 提供的中介介面會將面向開發人員的 API 與後端服務分離,讓開發人員不受程式碼變更影響,並在邊緣啟用創新功能,而不影響內部開發團隊。開發團隊進行後端變更時,開發人員會繼續呼叫相同介面,不會中斷。Apigee 可讓您向同一個 API 公開多個介面,讓您自由自訂 API 簽名,同時滿足各種開發人員的特殊需求。

API 基礎路徑和資源

透過網路位址和 URI 定義的 API。API 由基本路徑和一組 API 資源組成。每個 API proxy 都會定義基本路徑,並視需要定義多個 API 資源路徑。您可以將 API 想成是一系列 URI,所有 URI 都共用相同的基本路徑。

為方便管理 API,Apigee 會在這些原始 URI 中加入顯示名稱和說明。Edge 可讓您將政策和程式碼附加至 URI,進而精細控管 API 的行為。

API 產品

一系列 API 資源 (URI) 與配額或服務方案結合,並在設計階段發布給應用程式開發人員。接著,API 產品可再組合成 API 套件,用於營利。

API 金鑰會繫結至一或多個 API 產品,在應用程式與應用程式可使用的 URI 組合之間強制執行繫結。

API 套件 向開發人員呈現的 API 產品集合,通常與營利功能中定義的費率方案相關聯。
應用程式

應用程式的縮寫。應用程式一詞現在是指使用 API 的行動應用程式。開發人員會使用各種程式設計語言、技術和平台來實作應用程式。如要使用 API,開發人員必須在 Apigee Edge 中 API 供應商機構中註冊應用程式。

註冊應用程式時,Apigee 會產生可識別應用程式的 API 金鑰和密鑰。開發人員會在應用程式中嵌入 API 金鑰,並在提出要求時顯示該金鑰。API 服務會透過直接的 API 金鑰驗證或 OAuth 實作 API 金鑰安全性。

環境

API Proxy 的執行階段執行內容。您必須先將 API 代理程式部署至環境,才能透過網路存取公開的 API。根據預設,組織會配置兩個環境:testprod

  • 測試環境通常用於在開發期間部署 API Proxy。
  • 在 API Proxy 經過完整開發及測試後,通常會使用 prod 環境,將其從測試環境推廣至實際工作環境。
機構

Apigee Edge 帳戶中所有物件的容器,包括 API Proxy、API 產品、API 套件、應用程式和開發人員。

您必須為每個所屬機構建立使用者帳戶。(大部分使用者只會在一個機構中擁有帳戶)。

政策

在 API 代理處理流程中,以原子可重複使用的邏輯單位執行的處理步驟。

常見的政策導向功能包括轉換訊息格式、強制執行存取控制、呼叫遠端服務以取得其他資訊、遮蔽外部使用者的敏感資料、檢查訊息內容是否有潛在威脅、快取常見回應以改善效能等等。

系統可能會根據要求或回應訊息的內容或背景資訊,有條件地執行政策。舉例來說,如果要求訊息是從智慧型手機傳送,系統可能會執行轉換政策,以自訂回應格式。

API 資源路徑 資源路徑是 RESTful 概念,是一種統一資源 ID (URI),用於識別特定資源的網路路徑。
版本

面向開發人員的 API 介面版本。

例如 pivotaltracker.com/services/v3api.enterprise.apigee.com/v1

這個詞與修訂版本不同,後者是指將設定和政策封裝至 API Proxy 的編號版本控制套件。API 介面有版本,API Proxy 則有修訂版本。

修訂 已編號的版本控制設定套件,其中包含已整合至 API Proxy 的設定和政策。這個詞與「版本」不同,後者是面向開發人員的 API 介面。請參閱上述版本。