本頁面由 Cloud Translation API 翻譯而成。

透過 ESP 在 App Engine 彈性環境中開始使用 Cloud Endpoints

本教學課程說明如何在 App Engine 彈性環境中，設定與部署在執行個體上執行的範例 API 和可擴充服務 Proxy (ESP)。本文使用 OpenAPI 規範說明範例程式碼的 REST API。本教學課程也會說明如何建立 API 金鑰並用於對 API 的要求中。

如需 Cloud Endpoints 的總覽資訊，請參閱關於 Endpoints 和 Endpoints 架構。

取得程式碼範例

Java

如何複製或下載範例 API：

範例程式碼使用 Maven。如果您沒有 Maven 3.3.9 以上版本，請先下載並安裝。
將範例應用程式存放區複製到您的本機電腦：
```
git clone https://github.com/GoogleCloudPlatform/java-docs-samples
```
或者，您也可以選擇下載範例 ZIP 檔案，然後再解壓縮。

前往包含範例程式碼的目錄：

cd java-docs-samples/endpoints/getting-started

Python

如何複製或下載範例 API：

將範例應用程式存放區複製到您的本機電腦：
```
git clone https://github.com/GoogleCloudPlatform/python-docs-samples
```
或者，您也可以選擇下載範例 ZIP 檔案，然後再解壓縮。

前往包含範例程式碼的目錄：

cd python-docs-samples/endpoints/getting-started

如何複製或下載範例 API：

確定您已設定 GOPATH 環境變數。

將範例應用程式存放區複製到您的本機電腦：

go get -d github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started

前往包含範例程式碼的目錄：

cd $GOPATH/src/github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started

PHP

如何複製或下載範例 API：

將範例應用程式存放區複製到您的本機電腦：
```
git clone https://github.com/GoogleCloudPlatform/php-docs-samples
```
或者，您也可以選擇下載範例 ZIP 檔案，然後再解壓縮。

前往包含範例程式碼的目錄：

cd php-docs-samples/endpoints/getting-started

Ruby

如何複製或下載範例 API：

將範例應用程式存放區複製到您的本機電腦：
```
git clone https://github.com/GoogleCloudPlatform/ruby-docs-samples
```
或者，您也可以選擇下載範例 ZIP 檔案，然後再解壓縮。

前往包含範例程式碼的目錄：

cd ruby-docs-samples/endpoints/getting-started

NodeJS

如何複製或下載範例 API：

將範例應用程式存放區複製到您的本機電腦：
```
git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples
```
或者，您也可以選擇下載範例 ZIP 檔案，然後再解壓縮。

前往包含範例程式碼的目錄：

cd nodejs-docs-samples/endpoints/getting-started

設定 Endpoints

範例程式碼中包含以 OpenAPI 規格 v2.0 為基礎的 OpenAPI 設定檔 openapi-appengine.yaml。

如何設定 Endpoints：

在範例程式碼目錄中開啟 openapi-appengine.yaml 設定檔。

Java

swagger: "2.0"
info:
  description: "A simple Google Cloud Endpoints API example."
  title: "Endpoints Example"
  version: "1.0.0"
host: "YOUR-PROJECT-ID.appspot.com"

Python

swagger: "2.0"
info:
  description: "A simple Google Cloud Endpoints API example."
  title: "Endpoints Example"
  version: "1.0.0"
host: "YOUR-PROJECT-ID.appspot.com"

swagger: "2.0"
info:
  description: "A simple Google Cloud Endpoints API example."
  title: "Endpoints Example"
  version: "1.0.0"
host: "YOUR-PROJECT-ID.appspot.com"

PHP

swagger: "2.0"
info:
  description: "A simple Google Cloud Endpoints API example."
  title: "Endpoints Example"
  version: "1.0.0"
host: "YOUR-PROJECT-ID.appspot.com"

Ruby

swagger: "2.0"
info:
  description: "A simple Google Cloud Endpoints API example."
  title: "Endpoints Example"
  version: "1.0.0"
host: "YOUR-PROJECT-ID.appspot.com"

NodeJS

swagger: "2.0"
info:
  description: "A simple Google Cloud Endpoints API example."
  title: "Endpoints Example"
  version: "1.0.0"
host: "YOUR-PROJECT-ID.appspot.com"

注意事項：

設定範例會顯示 host 欄位附近的文字行，您必須修改這些文字行。如要將 openapi-appengine.yaml 部署至 Endpoints，您必須使用完整的 OpenAPI 文件。
範例 openapi-appengine.yaml 中包含用來設定驗證作業的區段，不過本教學課程無須執行這個步驟。您不需要設定含有 YOUR-SERVICE-ACCOUNT-EMAIL 和 YOUR-CLIENT-ID 的文字行。
OpenAPI 是一種各語言通用的規範。為求方便，相同的 openapi-appengine.yaml 檔案皆位於每個語言 GitHub 存放區的 getting-started 範例中。

在含有 host 欄位的文字行中，以您的 Google Cloud 專案 ID 取代 YOUR-PROJECT-ID。例如：
```
host: "example-project-12345.appspot.com"
```

Endpoints 使用 host 欄位中設定的文字做為服務名稱。在您將 API 部署至 App Engine 後端時，系統會自動建立名稱格式為 YOUR-PROJECT-ID.appspot.com 的 DNS 項目。

如要瞭解 Endpoints 所需的 OpenAPI 文件欄位，請參閱設定 Endpoints 一文。

部署 Endpoints 設定

如要部署 Endpoints 設定，請使用 gcloud endpoints services deploy 指令。這個指令會使用 Service Management 建立代管服務。

如何部署 Endpoints 設定：

確認您位於 endpoints/getting-started 目錄。

上傳設定並建立代管服務：

gcloud endpoints services deploy openapi-appengine.yaml

接著，gcloud 指令會呼叫 Service Management API，並使用您在 openapi-appengine.yaml 檔案 host 欄位中指定的名稱建立代管服務。Service Management 會依據 openapi-appengine.yaml 檔案中的設定建立服務。變更 openapi-appengine.yaml 時，您必須重新部署檔案才能更新 Endpoints 服務。

Service Management 在建立和設定服務時，會輸出資訊至終端機。您可以放心忽略 openapi-appengine.yaml 檔案中路徑不需要 API 金鑰的警告。完成服務設定程序之後，Service Management 會顯示含有服務設定 ID 與服務名稱的訊息，類似於以下內容：

Service Configuration [2017-02-13r0] uploaded for service [example-project-12345.appspot.com]

在上方的範例中，2017-02-13r0 是服務設定 ID，example-project-12345.appspot.com 則為 Endpoints 服務。服務設定 ID 是由一個日期戳記和一個修訂版本編號所組成。如果您在同一天再次部署 openapi-appengine.yaml 檔案，服務設定 ID 中的修訂版本編號就會遞增。您可以在 Google Cloud 主控台的「Endpoints」 >「Services」(服務) 頁面中查看 Endpoints 服務設定。

如果您收到錯誤訊息，請參閱 Endpoints 設定部署疑難排解一文。

檢查必要服務

Endpoints 和 ESP 至少需要啟用下列 Google 服務：

名稱	標題
`servicemanagement.googleapis.com`	Service Management API
`servicecontrol.googleapis.com`	Service Control API

在大多數情況下，gcloud endpoints services deploy 指令會啟用這些必要服務。不過在以下情況中，即便您成功執行 gcloud 指令，還是無法啟用必要服務：

您使用 Terraform 之類的第三方應用程式，而其中未包含這些服務。
您已將 Endpoints 設定部署至現有Google Cloud 專案，但在專案中已明確停用這些服務。

請使用下列指令確認必要服務已啟用：

gcloud services list

如果必要的服務並未列出，請執行下列指令加以啟用：

gcloud services enable servicemanagement.googleapis.com
gcloud services enable servicecontrol.googleapis.com

同時啟用 Endpoints 服務：

gcloud services enable ENDPOINTS_SERVICE_NAME

如要判斷 ENDPOINTS_SERVICE_NAME，您可以採取下列任一做法：

部署 Endpoints 設定後，請前往 Cloud 控制台的「Endpoints」頁面。「服務名稱」欄下方會顯示可能的 ENDPOINTS_SERVICE_NAME 清單。
如果是 OpenAPI，ENDPOINTS_SERVICE_NAME 是您在 OpenAPI 規格的 host 欄位中指定的內容。如果是 gRPC，ENDPOINTS_SERVICE_NAME 是您在 gRPC Endpoints 設定的 name 欄位中指定的內容。

如要進一步瞭解 gcloud 指令，請參閱 gcloud 服務。

部署 API 後端

到目前為止，您已將 OpenAPI 文件部署到 Service Management，但尚未部署為 API 後端提供服務的程式碼。本節會引導您將 API 範例和 ESP 部署至 App Engine。

如何部署 API 後端：

將您的服務名稱新增到 app.yaml 檔案中：

Java

開啟 endpoints/getting-started/src/main/appengine/app.yaml 檔案。

endpoints_api_service:
  # The following values are to be replaced by information from the output of
  # 'gcloud endpoints services deploy openapi-appengine.yaml' command.
  name: ENDPOINTS-SERVICE-NAME
  rollout_strategy: managed

Python