使用示例 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

需要使用 Python 才能运行 Apigee 部署工具。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 代理的环境（prod 或 test）。
  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 代理行为取决于特定的消息格式，因此代理可能需要进行额外的配置更改。