使用示例 API 代理

您正在查看的是 Apigee Edge 文档。
转到 Apigee X 文档
信息

前提条件

您需要一个 http://enterprise.apigee.com 账号。您可以在 http://accounts.apigee.com/accounts/sign_up 注册试用账号。

如需使用示例,您还应具备以下条件:

工具 说明
Git 相关示例位于 GitHub 上。如果您未安装 Git,请参阅 GitHub 的 Git 设置说明。如果您不想安装 Git,可以浏览相关文件并从 https://github.com/apigee/api-platform-samples 下载 ZIP 文件。
Python

运行 Apigee 部署工具需要使用 Python。Python 存在于大多数 Linux 环境中、安装了 XCode 的 Mac、安装了 Cygwin 的 Windows 计算机上以及其他许多地方。

要获取 Python,请参阅 Python 下载页面

curl 示例设置脚本也使用 curl。确保 curl 已安装并且在您的路径中可用(运行 which curl 命令以查看它在您的系统中是否可用)。
dos2unix 如果您是在 Windows 上运行 Cygwin,可能还需要 dos2unix 实用程序。(您可以使用 Cygwin 安装程序安装该实用程序)。

下载示例

如需获取示例文件,请使用 git clone,如以下示例所示:

git clone https://github.com/apigee/api-platform-samples.git

导入和部署示例 API 代理

从命令行导入并部署示例:

  1. 下载示例后,转到 /setup 目录,如以下示例所示:
    cd setup
  2. /setup 目录中,找到文件 setenv.sh
  3. 修改此文件以设置您的组织、与您的用户名关联的电子邮件地址,以及要在其中部署 API 代理的环境(生产环境或测试环境)。
  4. 修改 setenv.sh 后,请执行以下命令:
    sh deploy_all.sh

    此脚本会将所有 API 代理示例部署到您的组织。(该过程需要 3-4 分钟。)按照提示部署 API 产品、开发者和应用(用于 OAuth)。

  5. 部署脚本完成后,导航到 sample-proxies 目录。在 sample-proxies 目录中,您会发现每个示例代理都有一个目录。每个目录中都有一个 README.md 文件(其中包含有关运行示例的信息),以及两个脚本,可帮助您对示例稍作更改、进行部署,然后调用示例来查看更改所产生的效果:
    • invoke.sh:执行此脚本以调用 API 代理的已部署版本。
    • deploy.sh:执行此脚本以在进行任何更改后部署 API 代理。

调用示例 API 代理

每个示例代理都有一个关联的 Shell 脚本,您可以在部署 API 代理后使用该脚本来调用该代理。

/sample-proxies/proxy_name 目录执行以下命令:

sh invoke.sh

这将调用在贵组织的测试环境中运行的代理。

问题排查

如需了解问题排查信息,请参阅以下内容:

修改和重复使用示例 API 代理

示例代理的典型用途是修改、部署和调用。这样您就可以进行细微修改,然后查看它们对响应消息的影响。

如需将示例 API 代理修改为指向其他后端服务,请在以下位置修改 XML 配置文件:

/apiproxy/targets/target_name.xml

例如,要将 API 密钥示例指向您自己的后端服务,请找到以下文件:

/apikey/apiproxy/targets/default.xml

如果默认配置指向 http://mocktarget.apigee.net,例如:

<TargetEndpoint name="default">
  <HTTPTargetConnection>
    <!-- This is where we define the target. For this sample we just use a simple URL. -->
    <URL>http://mocktarget.apigee.net</URL>
  </HTTPTargetConnection>
</TargetEndpoint>

并且您的后端服务位于 http://api.myproject.com/,那么您可以修改配置,使其如下所示:

<TargetEndpoint name="default">
  <HTTPTargetConnection>
    <!-- This is where we define the target. For this sample we just use a simple URL. -->
    <URL>http://api.myproject.com/</URL>
  </HTTPTargetConnection>
</TargetEndpoint>

保存更改后,请按照以下示例部署 API 代理:

sh deploy.sh

可以通过相同的方式修改其他 API 代理,以便针对您现有的目标服务使用 API 代理功能。但是,在某些情况下,API 代理行为取决于特定消息格式,因此代理可能需要额外的配置更改。