OAuth 2.0：配置新的 API 代理

本页面适用于 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 文档。

客户端凭据授权类型定义了签发访问令牌以交换生成应用凭据的过程。这些应用凭据是 Apigee 针对组织内注册的每个应用签发的使用方密钥和密文对。如需了解详情，请参阅实现授权代码授权类型。

将 OAuth v2.0 添加到新的 API 代理

当您在 Apigee 界面中创建新的 API 代理时，可以向 API 添加 OAuth 验证功能。

要向 API 添加 OAuth 验证功能，请执行以下操作：

Cloud 控制台中的 Apigee

  1. 在 Google Cloud 控制台中，前往代理开发 > API 代理页面。

    前往 API 代理

  2. 在 Google Cloud 窗格的项目选择器中选择您的组织。组织名称与您的 Google Cloud 项目名称相同。
  3. 在 API 代理窗格，点击 + 创建。
  4. 在创建代理窗格的代理模板下，选择反向代理（最常见）。
  5. 请使用以下操作配置代理：
    名称 值
    代理名称 helloworld_oauth2
    基本路径

    /hellooauth2

    项目基本路径是用于向 API 代理发出请求的网址的一部分。
    说明 hello world protected by OAuth v2.0
    目标（现有 API）

    https://mocktarget.apigee.net/ip

    这会定义 Apigee 在向 API 代理发送请求时调用的目标网址。此目标只返回一个简单的响应：Hello, Guest!。
  6. 点击下一步。
  7. 部署（可选）：
    • 部署环境：可选。使用复选框选择要部署代理的一个或多个环境。 如果您不想在此时部署代理，请将部署环境字段留空。您可以稍后随时部署代理。
    • 服务账号：可选。将服务账号关联到您的部署，使代理能够访问服务账号角色和权限中指定的 Google Cloud服务。
  8. 点击创建。
  9. 在 helloworld_apikey 代理的代理摘要窗格中，点击开发标签页。
  10. 在政策菜单中，点击 添加政策。
  11. 在创建政策窗格中，选择安全性下的验证 API 密钥。
  12. 在 Verify API Key 窗格中，使用以下值填写名称和显示名称部分中的必填字段：
    • 名称：输入政策名称。例如，VerifyAPIKey。
    • 显示名称：输入要在界面中使用的政策名称。例如 Verify API Key。
  13. 点击创建。
  14. 点击 以添加其他政策。
  15. 在创建政策窗格中，选择中介下的分配消息。
  16. 在分配消息窗格中，使用以下值填充名称和显示名称部分中的必填字段：
    • 名称：输入政策名称。例如，AssignMessage。
    • 显示名称：输入要在界面中使用的政策名称。例如 Assign Message。
  17. 点击创建。

  18. 将分配消息政策的内容更新为以下内容：

    
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssignMessage async="false" continueOnError="false" enabled="true" name="remove-header-authorization">
    <DisplayName>Remove Header Authorization</DisplayName>
    <Remove>
        <Headers>
            <Header name="Authorization"/>
        </Headers>
    </Remove>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>
  19. 添加 VerifyApiKey 和 Remove Header Authorization 政策。
    1. 在代理端点菜单中，点击 Preflow。
    2. 在可视化编辑器的请求窗格中，点击 添加政策步骤。
    3. 在添加政策步骤窗格中，选择 Verify API Key。
    4. 点击添加。
    5. 在可视化编辑器的请求窗格中，点击 添加政策步骤。
    6. 在添加政策步骤窗格中，选择移除标头授权。
    7. 点击添加。
  20. 点击保存。

经典版界面

  1. 登录 Apigee 界面。
  2. 在左侧导航栏中，选择开发 > API 代理。
  3. 点击添加代理。
  4. 使用“创建代理”向导创建一个反向代理。请参阅构建一个简单的 API 代理。
  5. 在向导的通用政策页面上，选择 OAuth v2.0 旁边的单选按钮。
1 个新创建的 API 代理中，一个用于验证访问令牌，另一个用于在验证完成后删除访问令牌。

请注意，发布 API 产品复选框将变为可选中，且会被自动选中。如果您想要在构建新 API 代理时自动生成产品，请选中此复选框。将创建与新 API 代理相关联的自动生成的产品。如果您希望将现有产品与此新 API 相关联，请务必取消选中此复选框，以避免创建不必要的产品。如需了解商品，请参阅什么是 API 产品？