适用于 Python 的 Cloud Endpoints Frameworks 使用入门

本页面介绍了如何使用 Python 版 Cloud Endpoints Frameworks 配置、部署示例 API 以及向其发送请求。Python 版 Endpoints Frameworks 与 App Engine 标准 Python 2.7 运行时环境集成。Endpoints Frameworks 具备各种工具、库和功能，可供您通过 App Engine 应用生成 API 和客户端库。

目标

学习本教程时，请使用以下概要任务列表。为确保请求成功发送到 API，您必须完成所有任务。

1. 设置 Google Cloud 项目。请参阅准备工作。
2. 安装所需的软件并创建 App Engine 应用。请参阅安装和配置所需的软件。
3. 下载示例代码。请参阅获取示例代码。
4. 生成 OpenAPI 文档。请参阅配置 Endpoints。
5. 部署 Endpoints 配置以创建 Endpoints 服务。请参阅部署 Endpoints 配置。
6. 在计算机上运行该示例。请参阅在本地运行示例。
7. 创建后端，以提供 API 并部署 API。请参阅部署 API 后端。
8. 向 API 发送请求。请参阅向 API 发送请求。
9. 跟踪 API 活动。请参阅跟踪 API 活动。
10. 避免您的 Google Cloud 账号产生费用。请参阅清理。

费用

在本文档中，您将使用 Google Cloud的以下收费组件：

• Endpoints
• App Engine

如需根据您的预计使用情况来估算费用，请使用价格计算器。

完成本文档中描述的任务后，您可以通过删除所创建的资源来避免继续计费。如需了解详情，请参阅清理。

准备工作

1. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Roles required to select or create a project

   • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
   • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

   Go to project selector

2. Verify that billing is enabled for your Google Cloud project.

3. 记下 Google Cloud 项目 ID，稍后需要用到。

安装和配置所需的软件

1. 按照安装 Python 版 Google Cloud CLI 中的说明获取 App Engine 标准开发环境设置。请务必安装 app-engine-python 和 app-engine-python-extras gcloud 组件。
2. 运行以下命令：
   1. 更新 gcloud CLI。

      gcloud components update

   2. 确保 Google Cloud CLI (gcloud) 有权访问您在 Google Cloud上的数据和服务：

      gcloud auth login

   3. 在浏览器打开的新标签页中选择账号。
   4. 将默认项目设置为您的项目 ID。

      gcloud config set project [YOUR_PROJECT_ID]

      将 [YOUR_PROJECT_ID] 替换为您的 Google Cloud项目 ID。如果您有其他 Google Cloud 项目，并且想使用 gcloud 来管理这些项目，请参阅管理 gcloud CLI 配置。

3. 您需要一个应用来向示例 API 发送请求。

   • Linux 和 macOS 用户：本教程提供了一个使用 curl 的示例，它通常已预装在您的操作系统中。如果您没有 curl，可以从 curl 版本和下载页面中下载。
   • Windows 用户：本教程提供了一个使用 Invoke-WebRequest 的示例，PowerShell 3.0 及更高版本支持该命令。
4. 确保您的 python 开发环境包括 pip。
5. 确保您可以编译 Python 版 C 扩展程序。
   • Windows：需要 Microsoft Visual C++ 9.0 或更高版本。您可以从 Microsoft 下载中心下载 Microsoft Visual C++ 编译器（Python 2.7 版）
   • 其他操作系统：根据您使用的操作系统，您可能需要安装编译器工具（有时包含在软件包 build-essential 中）或 Python 开发头文件（有时包含在软件包 python-dev 中）。

6. 对于 Linux，将 ENDPOINTS_GAE_SDK 环境变量设置为您的 App Engine SDK 文件夹路径：[Path-to-Google-Cloud-SDK]/platform/google_appengine。

   将 [Path-to-Google-Cloud-SDK] 替换为以下命令的输出：

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

7. 创建 App Engine 应用：
   1. 选择要在其中创建 App Engine 应用的区域。运行以下命令以获取区域列表：

      gcloud app regions list

   2. 使用以下命令创建 App Engine 应用。将 [YOUR_PROJECT_ID] 替换为您的 Google Cloud项目 ID，并将 [YOUR_REGION] 替换为您要在其中创建 App Engine 应用的区域。

      gcloud app create \
      --project=[YOUR_PROJECT_ID] \
      --region=[YOUR_REGION]

      例如：

      gcloud app create --project=example-project-12345 --region=us-central