使用示例 API 代理

<ph type="x-smartling-placeholder"></ph> 您正在查看 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 部署工具。大多数 Linux 中都有 Python 环境中、安装了 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 minutes.)按照提示部署 API 产品、开发者和应用(用于 OAuth)。

  5. 部署脚本完成后,导航到 sample-proxies 目录。在 sample-proxies 目录中,每个示例代理会找到一个目录。在每个 是一个 README.md 文件,其中包含有关运行该示例的信息, 帮助您对示例稍作更改,进行部署,然后调用示例以查看 您更改的效果: <ph type="x-smartling-placeholder">
      </ph>
    • 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 代理行为 特定消息格式,因此代理可能需要其他配置更改。