部署和测试 API

本页面介绍如何部署您的 API。

准备工作

部署 API

您可以使用 App Engine Apache Maven 或 Gradle 插件部署 API。要将 API 部署到正式版 App Engine 标准环境，请按下文针对插件使用命令：

  1. 针对插件使用命令：

    Maven

    mvn appengine:deploy

    Gradle

    gradle appengineDeploy
  2. 等待部署完成。

  3. 向已部署的 API 发送测试请求。例如，使用 curl：

    curl \
    -H "Content-Type: application/json" \
    -X POST \
    -d '{"message": "echo"}' \
    "https://YOUR-PROJECT-ID.appspot.com/_ah/api/echo/v1/echo?n=2"

    您收到的响应应该类似于以下内容：

    {
  "message": "echo echo"
}

如果未成功收到响应，请参阅排查响应错误。

部署到多个应用版本

如需了解如何进行 API 版本控制以及如何部署到版本，请参阅处理 API 版本控制

在本地运行和测试 API 后端

要在本地测试您的 API，请执行以下操作：

  1. 在项目的根目录中构建项目。例如：

    Maven

    mvn clean package

    Gradle

    gradle clean build

  2. 启动 App Engine 开发服务器。例如：

    Maven

    mvn appengine:run

    Gradle

    gradle appengineRun

  3. 发出 API 请求以测试您的 API。例如，使用 curl：

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

从另一路径提供 API

如需通过不同的路径提供您的 API，请更改 web.xml 文件中 EndpointsServlet 部分的 url-pattern 并重新部署您的 API。例如：

<servlet-mapping>
    <servlet-name>EndpointsServlet</servlet-name>
    <url-pattern>/example-api/*</url-pattern>
</servlet-mapping>

添加 API 管理

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

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