OpenAPI 專用的 Cloud Endpoints

Cloud Endpoints 是一個 API 管理系統,可協助您以 Google 用於自己 API 的相同基礎架構,在您的 API 上保護、監控、分析和設定配額。Endpoints 可搭配可擴充服務 Proxy (ESP) 運作以提供 API 管理功能。您可以在關於 Endpoints 中進一步瞭解 Endpoints 和 ESP。

Endpoints 支援第 2 版的 OpenAPI 規範 (原名為 Swagger 規範),該規範是定義了 REST API 的業界標準。如果您不熟悉 OpenAPI 規範,請參閱 OpenAPI 總覽

本說明文件集說明如何將 Endpoints 搭配 OpenAPI 使用。如需其他 Endpoints 選項的說明文件,請參閱所有 Endpoints 文件

如要開始使用,建議您按照下列順序閱讀說明文件:

  1. 如要查看 Endpoints 功能的實務應用,請參閱 Cloud Endpoints 快速入門導覽課程,瞭解如何使用指令碼將範例 API 部署到 App Engine 彈性環境中。

  2. 現在您必須決定要用於 API 的運算平台。如需協助以做出決定,請參閱選擇運算選項一文,以及下方的支援的運算平台一節。

  3. 決定了您的 API 後端後,請參閱您偏好的運算平台的教學課程

支援的運算平台

OpenAPI 專用的 Endpoints 需要 ESP 才能管理 API。ESP 是一個開放原始碼專案,可透過下列方式使用:

  • Google Container Registry 中的容器。如要瞭解目前的 Docker 映像檔,請參閱 ESP 版本資訊
  • GitHub 中的原始碼。如要進一步瞭解如何建構 ESP,請參閱 ESP 讀我檔案

您可以在下列環境中,自行執行 ESP 容器:

App Engine 彈性環境中,只要在 app.yaml 檔案中加入幾行文字,就會自動部署 ESP。詳情請參閱部署您的 API 和 ESP 一節。

對於 App Engine 標準第 1 代環境,您必須使用 Endpoints Frameworks。如果您將容器部署至上述其中一個運算選項,則可設定 Proxy 至其中一代 App Engine 標準執行階段。

本頁內容對您是否有任何幫助?請提供意見:

傳送您對下列選項的寶貴意見...

這個網頁
Cloud Endpoints 搭配 OpenAPI
需要協助嗎?請前往我們的支援網頁