基本術語

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

Apigee 中有幾個常見概念,但意義獨特。

字詞 定義
API

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

API 可定義應用程式邏輯和資料的穩定簡化進入點,方便開發人員存取及重複使用其他開發人員建構的應用程式邏輯。如果是網路 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 Proxy 必須部署至環境,才能透過網路存取該 Proxy 公開的 API。根據預設,機構會佈建兩個環境:testprod

  • 測試環境通常用於在開發期間部署 API Proxy。
  • prod 環境通常用於在 API Proxy 完成開發和測試後,從測試環境升級。
機構

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

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

政策

在 API Proxy 處理流程中,以不可分割的可重複使用邏輯單元執行的處理步驟。

以政策為基礎的功能通常包括轉換訊息格式、強制執行存取控制、呼叫遠端服務以取得額外資訊、對外部使用者遮蓋敏感資料、檢查訊息內容是否有潛在威脅、快取常見的回覆以提升效能等。

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

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

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

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

這個詞彙與「修訂版本」不同,後者是指編號且受版本控管的設定和政策套件,會與 API Proxy 綁在一起。API 介面有版本,API Proxy 則有修訂版本。

修訂 以 API Proxy 形式封裝的設定和政策,並以編號控管版本。這個詞彙與版本不同,後者是開發人員使用的 API 介面。請參閱上述版本。