基本術語

您目前查看的是 Apigee Edge 說明文件。
參閱 Apigee X 說明文件
資訊

有幾個概念在 Apigee 中具有獨特的意義。

字詞 定義
API

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

API 定義了穩定的、簡化的進入點到應用程式邏輯和資料,讓開發人員能夠輕鬆存取及重複使用其他開發人員建構的應用程式邏輯。以網路 API 來說,該邏輯和資料會透過網路公開。使用 API 的應用程式非常容易變更,因此 API 亦暗示了合約。合約提供一定程度的保證,讓 API 隨時間演進變化。

Apigee 提供豐富的 API 資訊,以及開發及使用 API 的最佳做法。如要開始使用,請參閱 API 設計 Webcast 或下載免費的電子書《 Web API Design: The Missing Link Best Practices for the Crafting Interfaces》(開發人員喜愛的手工藝介面最佳做法)。

API Proxy

適用於一或多個 API、一般 HTTP 服務或應用程式 (例如 Node.js) 的 Edge 立面,

API Proxy 是以一組設定檔、政策和程式碼的形式實作,並依賴 Apigee Edge 提供的一組資源。您可以使用 Apigee Edge 管理 UI 產生及設定 API Proxy,也可以透過文字編輯器或 IDE 在本機上實作 API Proxy。

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 產品,通常與營利中定義的費率方案相關聯。
應用程式

application 的縮寫。「app」一詞所指的是使用 API 的行動應用程式。開發人員使用各種程式設計語言實作應用程式,並使用多種技術和平台。開發人員想要使用 API 的開發人員會在 Apigee Edge 的 API 供應商機構中註冊應用程式。

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

環境

API Proxy 的執行階段執行內容。您必須先將 API Proxy 部署至環境,才能透過網路存取公開的 API。根據預設,機構會佈建兩種環境:testprod

  • test 環境通常用於在開發期間部署 API Proxy。
  • prod 環境在經過完整開發及測試後,通常用於從測試環境宣傳 API Proxy。
機構

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

您加入的每個機構都必須擁有使用者帳戶。(多數使用者只會擁有一個機構中的帳戶)。

政策

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

常見的政策型功能包括轉換訊息格式、強制執行存取權控管、呼叫遠端服務以取得其他資訊、遮蓋外部使用者的機密資料、檢查訊息內容是否存在潛在威脅,以及快取常見的回應以提升效能等等。

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

API 資源路徑 符合 REST 樣式的概念,「資源路徑」是一種統一資源 ID (URI),可用來識別特定資源的網路路徑。
版本

供開發人員使用的 API 介面版本。

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

這個詞彙與「修訂版本」不同,後者是隨附於 API Proxy 中,並由版本管控的設定套件和政策組合。API 介面有版本,API Proxy 則有修訂版本。

修訂版本 隨附於 API Proxy 中,由版本管控的設定與政策套件。此詞彙與「版本」不同,後者是供開發人員使用的 API 介面。請參閱上方版本。