關於 Cloud Endpoints

Endpoints 是一個分散式 API 管理系統，提供 API 控制台、託管、記錄、監控及其他多項功能，可協助您建立、共用、維護及保護 API。本頁面提供 OpenAPI 專用的 Cloud Endpoints 的總覽。如要瞭解 Endpoints 支援的其他類型 API 架構，請參閱「所有 Endpoints 文件」。

Endpoints 可搭配分散式可擴充服務 Proxy (ESP) 或可擴充服務 Proxy 2.0 版 (ESPv2) 使用。每個 Proxy 都支援下列平台：

  • App Engine 彈性環境 (僅限 ESP)
  • Google Kubernetes Engine (ESP 或 ESPv2)
  • Compute Engine (ESP 或 ESPv2)
  • Kubernetes (ESP 或 ESPv2)
  • App Engine 標準 (僅限 ESPv2)
  • Cloud Run 函式 (僅限 ESPv2)
  • Cloud Run (僅限 ESPv2)
  • Knative serving (僅限 ESPv2)

透過 ESP 使用 Endpoints

Endpoints 使用分散式可擴充服務 Proxy (ESP)，提供低延遲和高效能服務，即使是需求最高的 API 也能提供服務。ESP 是一種以 NGINX 為基礎的服務 Proxy，因此您可以放心，它會視需要調整規模，以便處理 API 的同時要求。ESP 會在自己的 Docker 容器中執行，以便提供更佳的隔離和擴充性，並在 Container Registry 中發布。您可以搭配以下項目使用：

透過 ESPv2 使用 Endpoints

ESPv2 是一種以 Envoy 為基礎的高效能且可擴充的 Proxy，會在 OpenAPI 或 gRPC API 後端的前面執行。ESPv2 支援 OpenAPI 規範和 gRPC 規格的第 2 版。您可以搭配以下項目使用：

Endpoints API 管理功能

無論您是使用 Endpoints 搭配 ESP 或 ESPv2，都能享有許多重要的 API 管理功能，可讓您開發、監控及控制 API 存取權。

記錄檔和指標

Endpoints 使用服務基礎架構來管理 API 及回報記錄與指標，大多數 Google Cloud API 都使用相同的基礎架構。您可以在 Google Cloud 主控台的「Endpoints Services」(Endpoints 服務) 頁面管理及監控 API。

API 託管

Endpoints 已針對 Docker 容器環境進行最佳化，您可以在任何支援 Docker 且可透過網際網路存取Google Cloud之處託管您的 API。

使用 OpenAPI 專用的 Endpoints 開發 REST API

Endpoints 與程式設計語言種類無關。您可以用任何程式設計語言，以及支援使用 OpenAPI 設定檔說明 API 的 REST 架構來建構您的 API。

如要使用 OpenAPI 專用的 Endpoints，您必須進行下列操作：

  • 設定 Endpoints：您必須在 OpenAPI 設定檔中說明 API 的介面及設定 Endpoints 功能，例如 API 金鑰或驗證規則。

  • 部署 Endpoints 設定：在 OpenAPI 設定檔中定義 API 後，您必須使用 Google Cloud CLI 將 API 部署至 Endpoints 用來管理 API 的服務：Service Management。這樣 Endpoints 就會瞭解您的 API 所有資訊，並知道如何確保其安全。

  • 部署 API 後端：您必須將 ESP 或 ESPv2 和 API 後端部署至支援的 Google Cloud 後端，例如 Compute Engine。ESP 會在執行階段與 Endpoints 後端服務共同保護及監控 API。

控管 API 存取權

Endpoints 可讓您將 API 設定為任何呼叫都需要 API 金鑰，並驗證 API 金鑰。您也可以使用 Google Cloud 控制台與其他開發人員共用您的 API，讓他們可以啟用您的 API 並產生 API 金鑰來呼叫該 API。

驗證 API 使用者

對於大多數 API 呼叫，每個呼叫的另一端都有一位使用者。雖然 API 金鑰可以指出哪個應用程式正在呼叫您的 API，但是驗證程序可以確定哪位使用者正在使用該應用程式。

請注意，您的 API 伺服器仍需要決定通過驗證的使用者可以對您的 API 進行哪些操作。詳情請參閱 Google Cloud Auth 指南。

後續步驟

  • 請參閱 Endpoints 快速入門導覽課程來熟悉部署步驟和瞭解 Endpoints 功能的實務應用，瞭解如何使用指令碼將範例 API 部署至 App Engine 彈性後端。

  • 進行其中一個教學課程，進一步瞭解如何使用 Endpoints。