第 7 步:部署到 Apigee 环境

本页面适用于 ApigeeApigee Hybrid

查看 Apigee Edge 文档。

使用 Apigee in VS Code 完成本地开发和测试后,您就可以将 API 作为归档部署到 Apigee 环境中了。在此步骤中,您将创建支持归档部署的 Apigee 环境,并将 API 代理配置的归档部署到该 Apigee 环境。

  1. 按照创建环境中的步骤执行以下操作:
    1. 在 Apigee 组织中创建新的开发环境,并启用归档作为部署类型。使用界面API

      例如:

      显示归档部署类型设置的“新建环境”对话框

    2. 使用 Instances attachment API 将环境连接到运行时实例。

      此命令会触发长时间运行的操作。在继续操作之前,请确保环境已连接到运行时。

    3. 使用 Create environment groups API 创建环境组(如果您还没有环境组)。

      在继续操作之前,请确保已创建环境组。您可以使用如下请求来检查新组的状态:

      curl -i -H "$AUTH" -H "Content-Type:application/json" \
        "https://apigee.googleapis.com/v1/organizations/$PROJECT_ID/environments/ENVIRONMENT_NAME"

    4. 使用 Environment Group Attachment API 将新环境连接到环境组。

      将环境连接到组会使该环境中的代理可通过组中的主机名路由。 这会触发长时间运行的操作,可能需要几分钟才能完成。建议您等待一两分钟,然后再继续下一步。在此期间,您可以像之前一样检查操作的状态。

  2. 将 API 代理配置的归档部署到 Apigee 环境。
    1. 在 Apigee VS Code 的 Terminal 标签页中,导航到 myapigeeworkspace 目录。
      cd myapigeeworkspace

      运行 ls 时,目录应包含 src 文件夹。

    2. 运行以下命令:
      gcloud beta apigee archives deploy --environment=dev --labels=release=052021

      以下提供了一个响应示例:

      Using Apigee organization dev
      Waiting for operation [b64c2665-b5ac-43cc-9e2d-232e8895c2ed] to complete...done
  3. Terminal 标签页中运行以下命令来测试 API:
    curl https://INTERNAL_LOAD_BALANCER_IP/helloworld /
      -H "Host: ENV_GROUP_HOSTNAME" 

    如需详细了解本示例中的变量以及如何设置 API 访问权限,请参阅部署示例代理

    显示以下错误消息:

    {"fault":{"faultstring":"Failed to resolve API Key variable request.queryparam.apikey",
      "detail":{"errorcode":"steps.oauth.v2.FailedToResolveAPIKey"}}}
    

    您需要创建一个包含 helloworld API 的 API 产品,然后创建开发者并将其注册到该 API 产品以获取 API 密钥。

  4. 获取 API 密钥。
    1. 使用 Apigee 界面创建 API 产品:
      1. 选择发布 > API 产品
      2. 点击 + 创建
      3. 输入 API 产品的产品详细信息。
      4. 在对应字段中分别输入以下信息:
        字段 设置
        Name: myproduct
        Display name: myproduct
        Environment: dev
        Access: 公开
        Quota: 留空
        Allowed OAuth scope: 留空
      5. 操作部分中,点击 + 添加操作
      6. 来源 (Source) 下,从“API 代理”(API Proxy) 下拉菜单中选择 helloworld
      7. 操作下的“路径”字段中,输入 /

        将其他字段保留为默认值。

      8. 点击保存以保存该操作。
      9. 点击保存以保存该 API 产品。
    2. 在组织中创建开发者:
      1. 在导航菜单中选择发布 > 开发者
      2. 点击 + 开发者
      3. 在对应字段中分别输入以下信息:
        字段 设置
        First Name: Alex
        Last Name: Hamilton
        Username: ahamilton
        Email: ahamilton@example.com
      4. 点击创建
    3. 注册一个应用:
      1. 选择发布 > 应用
      2. 点击 + 应用
      3. 在对应字段中分别输入以下信息:
        字段 设置
        Name: myapp
        Display name: myapp
        Developer: ahamilton@example.com
        Callback URL: 留空
        Notes: 留空
        Expiry: 永不
        Product:
        1. 点击添加产品
        2. 选择 myproduct
        3. 点击添加
        Custom attributes: 留空
    4. 复制 API 密钥。
      1. 在“应用”页面(发布 > 应用)上,点击 myapp
      2. myapp 页面上,在凭据部分中,点击密钥旁边的显示。请注意,API 密钥与您创建的 API 产品相关联。
      3. 选择并复制 API 密钥。
  5. 再次运行 curl 调用,使用 apikey 查询参数传递 API 密钥,如下所示:
    curl -v https://$PUBLIC_FACING_IP/helloworld?apikey=ZQA5euYtNeJ7ZCGCJMpvd6F2BZOmxOzY

    返回以下响应:

    {
      "root": {
        "city": "San Jose",
        "firstName": "John",
        "lastName": "Doe",
        "state": "CA"
      }
    }

恭喜!您已成功将 API 归档部署到 Apigee 环境!

在下一步中,您需要将 API 归档提升到 Apigee 生产环境。

1 2 3 4 5 6 7 (下一步)第 8 步:将归档升级为正式版