此页面由 Cloud Translation API 翻译。

开发工具

<ph type="x-smartling-placeholder"></ph> 您正在查看 Apigee Edge 文档。
转到 Apigee X 文档。信息

作为服务提供商，您可以开发供客户端应用使用的 API。要创建、配置 API 代理和 API 产品后，您可以使用该界面或向 API 服务器发出 HTTP 请求，用于访问 RESTful 服务的 API，如以下部分所述。

使用 Edge 界面

Apigee Edge 界面是一款基于浏览器的工具，可用于创建、配置和管理 API 代理和 API 产品。有些任务只能使用 API 完成，。

下表介绍了如何访问 Edge 界面：

产品	界面名称	访问网址
Edge	Edge 界面	如需访问 Edge 界面，请使用以下网址： https://apigee.com/edge 有关使用 Edge 界面的教程，请参阅构建您的第一个 API 代理。
适用于私有云的 Edge	经典 Edge 界面	如需访问适用于私有云的 Edge 界面，请使用以下网址： http://`ms-ip`:9000 其中，`ms-ip` 是管理服务器节点的 IP 地址或 DNS 名称。

产品

界面名称

访问网址

Edge

Edge 界面

如需访问 Edge 界面，请使用以下网址：

https://apigee.com/edge

有关使用 Edge 界面的教程，请参阅构建您的第一个 API 代理。

适用于私有云的 Edge

经典 Edge 界面

如需访问适用于私有云的 Edge 界面，请使用以下网址：

http://ms-ip:9000

其中，ms-ip 是管理服务器节点的 IP 地址或 DNS 名称。

使用 Edge 界面，您可以：

您可以通过修改代码并通过代理跟踪请求流来创建 API 代理。
创建捆绑代理以向客户端请求公开的 API 产品。
管理开发者和开发者应用。
配置测试和生产环境。
实现 JavaScript 和 Node.js 应用。

下图显示了界面中的 API 代理编辑器，您可以使用该编辑器创建和配置 API 代理：

显示在 Edge 界面的 API 代理编辑器中选中的“开发”标签页。

使用 Edge API

您可以使用 Edge API 管理 API 资源。这些 API 还提供对 API 中未公开的低级别功能的访问权限。界面。

API 端点通常获取包含配置信息的数据，您需要请传递身份验证信息（例如用户名和密码），以对其进行访问。关注 RESTful 您可以调用 HTTP GET、POST、PUT 以及 DELETE 方法。

如需查看 Apigee Edge API 的完整列表，请参阅 Apigee Edge API 参考文档。

了解 Edge API 基础路径

您将在 API 请求中使用的路径将以下各项串联起来：

包含您的组织名称的基本路径。例如：https://api.enterprise.apigee.com/v1/organizations/org_name
指向您正在访问的 Edge 资源的端点。

例如，如果您的组织名称是 apibuilders，那么您每次调用 API 将使用以下基本路径：

https://api.enterprise.apigee.com/v1/organizations/apibuilders

要检索组织中的 API 代理列表，您需要对以下内容调用 GET：

https://api.enterprise.apigee.com/v1/organizations/apibuilders/apis

许多资源都按环境划分范围。默认情况下提供两种环境：test 和生产环境。例如，缓存按环境划分范围。名为“mycache”的共享缓存已包含每个环境中都默认启用此配置

您可以通过对缓存资源调用 GET 来列出缓存，如下所示：

https://api.enterprise.apigee.com/v1/organizations/apibuilders/environments/test/caches
https://api.enterprise.apigee.com/v1/organizations/apibuilders/environments/prod/caches

对访问权限进行身份验证

调用 API 时，您必须向 API 服务器进行身份验证。您可以方法之一：

OAuth2
SAML
基本身份验证（不推荐）

此外，Apigee 建议您使用双重身份验证，如启用为您的 Apigee 账号启用双重身份验证。

Edge API 限制

每个组织都存在以下 Edge API 调用频率上限：

使用付费方案的组织每分钟可发出 10,000 次调用
试用组织每分钟 600 次调用

HTTP 状态代码 401 和 403 不计入此限制。任何超出限制会返回 429 Too Many Requests 状态代码。

有关使用 Edge API 的提示

本部分介绍了一些使用 Edge API 的技巧。

缩写请求网址

构建指向 Edge API 的请求网址时，您可以使用以下缩写：

/e = /environments
/o = /organizations
/r = /revisions

如果使用缩写，则必须保持一致。也就是说，将或无。在同一路径中同时使用完整元素和缩写元素会导致错误。

例如：

THIS:
https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval/environments/prod/apis/helloworld/revisions/1/deployments
CAN BE MUCH SHORTER:
https://api.enterprise.apigee.com/v1/o/ahamilton-eval/e/prod/apis/helloworld/r/1/deployments

执行 curl 命令

使用 HTTP 客户端向 API 发出请求。文档中有很多示例使用广泛使用的 HTTP 客户端 curl 提供示例 API 请求。如果您需要安装 curl，即可从以下位置下载： http://curl.haxx.se.

对该 API 的调用支持 gzip 压缩响应。如果您在 API 调用中设置了 'Accept-Encoding: gzip, deflate'，则以 gzip 格式返回超过 1024 个字节的响应。

设置 XML 和 JSON 请求和响应的格式

默认情况下，Edge API 以 JSON 格式返回数据。对于许多请求，您可以以 XML 的形式发回。为此，请将 Accept 请求标头设置为 application/xml，如以下示例所示：

curl -H "Authorization: Bearer `get_token`" \
  -H "Accept: application/xml" \
  https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval/apis/helloworld/revisions/1/policies/ \
  | xmllint --format -

响应应如下所示：

<List>
  <Item>SOAP-Message-Validation-1</Item>
  <Item>Spike-Arrest-1</Item>
  <Item>XML-to-JSON-1</Item>
</List>

请注意，此示例使用 prettyprint 来显示结果，方法是将响应 xmllint。

acurl 实用程序不支持 Accept 头文件。因此，您可以使用 acurl 时只能获得 JSON 格式的响应。

如需对 JSON 响应使用 prettyprint，您可以使用 json.tool Python 库：

curl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval/apis/helloworld/revisions/1/policies/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer `get_token`" \
  | python -m json.tool

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

[
  "SOAP-Message-Validation-1",
  "Spike-Arrest-1",
  "XML-to-JSON-1"
]

对于 XML，您可以使用 xmllint：

curl https://ahamilton-eval-test.apigee.net/getstarted -u email_address | xmllint --format -

在 XML 中 POST 或 PUT 载荷时，请使用 Content-type HTTP 标头：

acurl -H "Content-type:text/xml" -X POST -d \
'<XMLPayload>
 </XMLPayload> ' \
https://api.enterprise.apigee.com/v1/organizations/apifactory/apis -u email_address

部署环境

默认情况下，每个使用 Apigee Edge 的组织都至少有两个环境可用于开发、测试和部署 API：“测试”和“prod”。使用“test”部署和测试然后再公开 API。只有内部开发者可以访问 API 部署到测试环境将 API 部署到“生产环境”使其公开面向应用开发者提供

调试和测试

Apigee 提供了跟踪工具，供您用于调试端到端的请求和响应流量。跟踪结果显示请求和响应标头和载荷、政策执行变量值以及流程中可能发生的任何错误。

在排查问题时，可以参考以下关键数据点：

时间戳：使用时间戳来了解每个步骤的执行时长。比较时间戳有助于您分离出执行时间最长的政策降低 API 调用速度
基本路径：通过验证基本路径，您可以确保政策是将邮件转送到正确的服务器。
政策执行结果：这些结果可让您了解邮件是否被是否按预期更改。例如，如果将消息从 XML 转换为 JSON，或者如果正在缓存消息。

下图显示了跟踪记录结果：

显示在 Edge 界面的 API 代理编辑器中选中的“Trace”标签页。

每个 Trace 会话都分为以下主要步骤：

从客户端接收的原始请求：显示来自客户端应用的请求、标头、正文数据和查询参数。
请求发送到您的后端服务：显示发送到通过 API 代理访问后端服务
后端服务返回的响应：显示响应标头和载荷。
发送到客户端的最终响应：返回到在响应流执行完毕后，请求客户端应用。