部署和测试 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 管理功能，例如：

要将您的 API 交给 Endpoints Frameworks 来管理，您必须生成并部署一个用于描述 API 的 OpenAPI 文档，如添加 API 管理中所述。