全面了解 Java 版 Cloud Endpoints Frameworks

本页面介绍库和工具，并提供其他信息以帮助您开始使用 Java 版 Endpoints Frameworks。请参阅关于 Endpoints Frameworks，了解 Endpoints Frameworks 的架构概览。

库和工具

App Engine 标准环境的 Cloud Endpoints Frameworks 提供以下库和工具：

• 您可以从 Maven Central Repository 的 com.google.endpoints 组中下载 Endpoints Frameworks。所需的基本 .jar 文件位于 endpoints-framework 工件中。如需了解详情，请参阅 API Javadoc。
• endpoints 命令行工具（适用于 Linux）或 endpoints.cmd（适用于 Windows），可用于生成客户端库软件包和发现文档，使 Android 应用和其他类型的客户端应用能够访问您的 API。
• Endpoints Frameworks Maven 插件和 Endpoints Frameworks Gradle 插件，可用于生成以下各项：
  • 客户端库软件包和发现文档。
  • OpenAPI 配置文件，可用于实现 API 管理功能（例如监控、日志记录和 API 密钥验证）。

注意：由于 API 后端是 App Engine 应用，因此开发者可以使用 App Engine 标准环境中提供的服务和功能，例如 Datastore、Cloud Storage、Mail、URL Fetch、Task Queues 等。最后，通过使用 App Engine 作为后端，开发者可以从系统管理工作、负载均衡、扩缩和服务器维护中解脱出来。

使用要求

要使用 Endpoints Frameworks，请按照教程中显示的过程进行操作。

您需要知道如何开发您选择的客户端（例如 JavaScript Web 客户端）或移动客户端（例如 Android）。

注意：您无法直接从推送任务队列或 Cron 作业调用 Cloud Endpoints API。

开发流程

使用 Endpoints Frameworks 开发应用的一般工作流程如下所述：

1. 创建您的 API 项目，然后编写 API 代码。
2. 为您的 API 添加注释，以便用它生成类和客户端库。
3. 如教程中所述，生成 OpenAPI 配置文件并部署该文件。
4. （可选）在本地测试您的 API。
5. 部署此 API。
6. 生成客户端库。
7. 在调用 API 时使用客户端库编写客户端应用。

使用入门

如需开始使用，请按照教程配置和部署示例 API 并向示例 API 发送请求。然后返回本部分，了解配置、部署和测试自己的 API 所需的信息。

从 Endpoints 1.0 版迁移

如果您已使用 Endpoints 的先前版本开发 API 后端，请按照迁移指南将您的应用迁移至 Endpoints 2.0 版。