注意:此产品的某些方面处于 Beta 版阶段。Hybrid 安装选项是 GA。要加入 Beta 版计划,请与您的 Apigee 代表联系。

Apigee API 使用入门

Apigee API 可用于通过一组 RESTful 操作以编程方式开发和管理 API。

您可以使用 Apigee API 将 API 代理管理集成到贵组织的软件开发生命周期 (SDLC) 中。Apigee API 的一个常见用途是编写脚本或代码,以部署 API 代理或将 API 代理从一个环境迁移到另一个环境,这也是大型自动化流程的一部分,该流程还部署或迁移其他应用程序。

如需了解详情,请参阅 Apigee API

启用 Apigee API

确保您已启用 Apigee API。如需为项目启用 API,最简单的方法是使用 Google Cloud Console。如需了解完整详情,请参阅第 3 步:启用 API

获取 OAuth 2.0 访问令牌

Apigee API 支持 OAuth 2.0 进行用户身份验证。借助 OAuth 2.0,您可以将 Google Cloud 凭据交换为访问令牌,以便用于安全地调用 Apigee API。获取令牌后,在令牌失效之前,您不再需要交换凭据。

如需获取 OAuth 2.0 访问令牌,请执行以下操作:

  1. 使用 GCP Console 为您的服务帐号生成密钥,如创建和管理服务帐号密钥中所述。

    包含您的服务帐号凭据的 JSON 文件就会下载到您的计算机。

  2. 使用 Google Cloud 凭据,您可以通过以下任一方法获取 OAuth 2.0 访问令牌,以通过调用 Apigee API 来传递:

    gcloud

    使用 gcloud 获取 OAuth 2.0 访问令牌,传递您在第 1 步中使用 GOOGLE_APPLICATION_CREDENTIALS 环境变量下载的服务帐号凭据 JSON 文件。如需了解详情,请参阅 gcloud beta auth application-default print-access-token

    export GOOGLE_APPLICATION_CREDENTIALS=~/sa-credentials-file.json
    gcloud auth application-default print-access-token

    oauth2l 实用程序

    使用 oauth2l 获取 OAuth 2.0 访问令牌,传递您在第 1 步中下载的服务帐号凭据 JSON 文件。

    oauth2l fetch --json ~/sa-credentials-file.json cloud-platform

    返回 OAuth2.0 令牌。

  3. 复制返回的 OAuth 2.0 令牌并将其存储在变量中,例如 TOKEN。例如:
    export TOKEN=ya29....Ts13inj3LrqMJlztwygtM
  4. 调用 Apigee API 时,请在 Authorization 标头中传递 OAuth 2.0 访问令牌。例如:
    curl "https://apigee.googleapis.com/v1/organizations/myorg/apis/myApiProxy" \
    -X GET \
    -H "Authorization: Bearer $TOKEN"

为 Apigee API 请求设置环境变量

文档中提供的 Apigee API 和 gcloud CLI 示例使用下表中定义的一个或多个环境变量。

通过在环境中将环境变量预先设置为有意义的值,您可以复制并粘贴示例请求,然后只需做极少的修改或不做更改,即可在自己的环境中执行它们。

环境变量 说明
$API 您的 API 代理的名称。
$ENV 您的环境名称,例如 testprod
$ORG 您的 Apigee 组织。
$APP 应用的 ID。
$REV 您的 API 代理的修订版本号。

使用 curl

本部分中的示例使用 curl 来演示如何使用 Apigee API 开发应用。curl 是一种开源命令行工具,用于通过网址语法传输数据,支持 HTTP 和 HTTPS 等常见协议。

下表汇总了示例中使用的 curl 命令行选项。

选项 说明
-d '{}' --data @filename
--data-binary @filename
定义您可以直接传递或通过指定文件名的请求正文。
-F file=@filename
--form file=@filename
定义可通过指定文件名传递的基于表单的数据。
-H
--header
定义请求标头。

您必须在请求标头中传递以下信息:

  • Authorization 标头:用于用户身份验证的 OAuth 2.0 令牌,如获取 OAuth 2.0 访问令牌中所述。
  • Content-Type 标头:使用 API 创建或更新资源(POST、PATCH、PUT)时发送的请求正文的内容类型。
-X 指定请求的类型(GET、POST 等)。

例如:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apis" \
   -X GET \
   -H "Authorization: Bearer $TOKEN"

按照获取 OAuth 2.0 访问令牌中的说明,将 $TOKEN 设置为您的 OAuth 2.0 访问令牌。