本页面介绍了相关库和工具,并提供了一些其他信息,旨在帮助您开始使用 Python 版 Endpoints Frameworks。请参阅关于 Endpoints Frameworks,了解 Endpoints Frameworks 的架构概要。
库和工具
适用于 App Engine 标准环境的 Cloud Endpoints Frameworks 提供以下库和工具:
- Frameworks 库。
endpointscfg.py
命令行工具,可用于生成以下内容:- 客户端库软件包和发现文档,可让 Android 应用和其他类型的客户端应用访问您的 API。
- OpenAPI 配置文件,可用于实现 API 管理功能(例如监控、日志记录和 API 密钥验证)。
使用要求
要使用 Endpoints Frameworks,请按照教程中显示的过程进行操作。
最后,您需要了解如何开发您偏好的客户端,例如 JavaScript 网页客户端或 Android 等移动客户端。
开发流程
使用 Endpoints Frameworks 开发应用的一般工作流程如下所述:
- 先编写 API 代码,在其中封装类及任何公开的方法并创建
Message
类(请参阅创建 Endpoints API)。 - 创建一个网络服务器,以用于提供您的 API。
- 生成 OpenAPI 配置文件并部署该文件,参见教程。
- (可选)在本地测试您的 API。
- 部署此 API。
- 生成客户端库。
- 编写客户端应用,调用 API 时应使用客户端库。
使用入门
如需开始使用,请按照教程配置和部署示例 API 并向示例 API 发送请求。然后返回本部分,了解配置、部署和测试自己的 API 所需的信息。
从 Endpoints 1.0 版迁移
如果您已使用 Endpoints 的先前版本开发 API 后端,请按照迁移指南将您的应用迁移至 Endpoints 2.0 版。