部署及測試 API

本頁面說明如何部署 API。

事前準備

• 設定程式設計環境和下載工具。
• 建立 API。
• 建立網路伺服器以提供您的 API。

將您的 API 部署至實際工作環境

如何部署 API：

1. 將 ENDPOINTS_GAE_SDK 環境變數設定為 App Engine SDK 資料夾的路徑：Path_to_Cloud_SDK/platform/google_appengine。

   將 Path_to_Cloud_SDK 替換為以下指令的輸出內容：

    gcloud info --format="value(installation.sdk_root)"
   

2. 在 API 主目錄中執行下列指令：

    gcloud app deploy
   

   稍等片刻，等待部署成功，並請忽略警告訊息。部署完成後，您將看到類似以下的訊息：

   File upload done.
   Updating service [default]...done.
   

3. 向 API 發送測試要求以確認成功部署，例如：

   curl --request POST \
      --header "Content-Type: application/json" \
      --data '{"content":"echo"}' \
      https://PROJECT_ID.appspot.com/_ah/api/echo/v1/echo?n=2
   

   請將 PROJECT_ID 替換為您的專案 ID，並將 echo 替換為您的 API 名稱。

   結果如下：

   {
    "content": "echo echo"
   }
   

如果您未取得成功的回應，請參閱排解回應錯誤一文。

部署至多個應用程式版本

如要瞭解如何進行 API 版本管理，以及如何部署到版本，請參閱處理 API 版本管理一文。

在本機測試 API

您可以使用 App Engine 本機開發伺服器，在本機測試您的 API。如要進一步瞭解本機開發伺服器，請參閱使用本機開發伺服器一文。

如何在本機執行 API：

1. 從專案的根目錄啟動 App Engine 開發伺服器：

   dev_appserver.py YOUR_PROJECT_DIR
   

2. 執行 curl 以提出 API 要求，例如：

    curl --request POST \
       --header "Content-Type: application/json" \
       --data '{"message":"echo"}' \
       "${HOST}/_ah/api/echo/v1/echo?n=2"
   

新增 API 管理

Endpoints Frameworks 提供 API 管理功能，例如：

• Monitoring
• Logging
• 配額
• 開發人員入口網站

如要讓 Endpoints Frameworks 能夠管理 API，您必須如新增 API 管理一文所述，產生及部署說明 API 的 OpenAPI 文件。