您正在查看 Apigee Edge 文档。
转到 Apigee X 文档。 信息
Apigee Edge API 示例包含示例 API 代理、政策、代码和工具，用于说明下文所述的 Apigee Edge API 服务的功能。
如需了解如何使用示例，请参阅使用示例 API 代理。
在实践中学习
想要迅速上手，开始建立关于 Apigee Edge 的坚实知识库吗？我们在 GitHub 中有一个“学习边缘”示例库，可让您快速部署、调用和跟踪一些示例代理，从最简单的代理开始，然后继续介绍用于说明 API 密钥验证、配额、响应缓存、故障处理等功能的代理。
克隆完代码库并设置环境（只需几分钟）后，不到一分钟内即可试用每个示例。而且，由于每个示例都会创建同一代理的新修订版本，因此您的环境不会有大量示例杂乱无章。您可以切换修订版本、在管理界面中重新部署不同的修订版本，以及随时查看代理代码。每个示例的自述文件还简要说明了示例的功能及其设置方式。
快来试试吧！https://github.com/apigee/api-platform-samples/tree/master/learn-edge
文档实战宝典示例
我们针对 API 代理实战宝典主题提供了一组示例。
| 名称 | 说明 | 政策类型 | 资源 |
|---|---|---|---|
| javascript-cookbook | 展示一个简单的 JavaScript 代码段，该代码段通过变量添加 HTTP 标头，将 XML 格式的天气预报从 JSON 转换为 XML，并针对移动客户端缩减内容。 | min.js setHeaders.js |
|
| javascript-mashup-cookbook | 一个完整的 JavaScript 应用，它会调用公共 API、合并结果并为客户端应用生成丰富响应。（注意：此 API 代理实现与政策混搭实现相同的功能，其作用在于证明可以使用不同技术解决同一问题。） | JavaScript | MashItUp.js |
| java-hello | 简单的 Hello World Java 调用程序。 | JavaCallout | JavaHello.java |
| java 实战宝典 | 将响应内容和标头转换为大写。 | JavaCallout |
ResponseUppercase.java |
| Java 属性 | 演示如何在 Java 调用程序中使用属性。 | JavaCallout | JavaProperties.java |
| java-error | 演示可在 Java 调用程序代码中使用的错误处理模式。 | JavaCallout | JavaError.java |
| policy-mashup-cookbook | 使用政策组合调用两个公共 API、合并结果并为客户端应用生成丰富响应的完整应用。（注意：此 API 代理实现与 javascript-mashup 相同的功能，可证明可以使用不同技术解决同一问题。） | AssignmentMessage ServiceCallout ExtractVariables Javascript XMLToJSON |
GenerateResponse.js |
示例 API 代理
以下 API 代理位于 GitHub 中，其中 readme 页面提供了示例的详细说明。如果您想了解特定政策在示例中的工作原理，请在下面的“政策类型”列中查找您感兴趣的政策，然后在“名称”列中点击示例名称。（这些政策链接到其文档中的相应参考页面。）
参考资料和工具
除了上表中的文档实战宝典示例和示例代理之外，Edge GitHub 示例还包含以下资源：
| 名称 | 说明 | 政策类型 | 资源 |
|---|---|---|---|
| regex-protection | 正则表达式威胁防护政策可以保护您的后端 API 和微服务免受 SQL 注入攻击。 | 不适用 | |
| oauth-validate-key-secret | 您正在实现 OAuth 密码授权类型流程。在调用外部身份提供方来验证用户的凭据之前，您需要在 Edge 上验证应用客户端密钥和密文。 | OAuthV2 等 | 不适用 |
| 条件模式匹配 | 借助此代理，您可以轻松试用和测试 API 代理流程中的条件语句。 | AssignMessage | 不适用 |
| access-entity | 介绍如何从 Apigee Edge 数据存储区中检索实体的配置文件。 | AssignmentMessage AccessEntity ExtractVariables |
无 |
| apikey | 实现简单的 API 密钥验证 | VerifyAPIKey AssignmentMessage 配额 |
无 |
| async-callout | 演示使用 JavaScript httpClient 的简单异步调用程序。 | JavaScript | compile_response.js callout.js |
| base64encoder | 演示了如何从 API 代理中的 JavaScript 资源调用 JavaScript include。 | AssignmentMessage JavaScript |
core-min.js enc-utf16-min.js enc-base64-min.js encodeAuthHeader.js |
| 条件政策 | 实现简单的条件政策强制执行。当请求包含 HTTP 标头 responsetime:true 时，政策会执行 Python 脚本，该脚本将一组性能指标作为 HTTP 标头添加到响应消息中 | 脚本 (Python) | time.py |
| dynamic-endpoint | 在稍微复杂一点的场景中实现简单的条件路由，即定义两个网址和一个默认路由。 | 无 | 无 |
| jira-release-notes | 这是 Apigee 文档团队用于从 Jira 生成版本说明的 API 代理。 | JSONToXML XSL |
releasenotes_api.xsl |
| kerberos-credential-Mediation | 此示例展示了如何在 Apigee Edge 上执行 Kerberos 凭据中介。 | JavaCallout | Java JAR 文件 |
| oauth-advanced | 授权代码授权类型流程的完整、可行示例，其中授权服务器为 Apigee Edge。 |
GenerateAccessToken 许多其他... |
查看示例代码 |
| oauth-client-credentials | 演示为客户端凭据授权类型配置且功能齐全的 OAuth 2.0 令牌端点。 | GenerateAccessToken | 无 |
| oauth-login-app | 已弃用。我们建议您查看 oauth-advanced 示例。 | ||
| oauth-validate-key-secret | 演示了在调用身份提供方以在密码授权类型流程中验证用户凭据之前验证客户端密钥和密文的方法。 | OAuthV2 AssignmentMessage ExtractVariables ServiceCallout 尚有 Fault |
无 |
| oauth-verify-accesstoken | 演示了一个配置为验证 OAuth 2.0 访问令牌并验证配额的 API 代理。 | VerifyAccessToken 配额 |
无 |
| oauth10a-3legged | 演示了三足式 OAuth 1.0a 配置。 | GenerateAceessToken GenerateRequestToken ServiceCallout VerifyAccessToken |
无 |
| outbound-oauth | 使用 Microsoft Azure translator API 翻译推文。为此，它会发出出站调用以获取 OAuth 访问令牌，然后使用 API 服务缓存政策来缓存令牌，在每次发出出站调用时重复使用缓存的令牌。 此外，还包括用于调用 API 代理的演示版浏览器应用。 | assignMessage LookupCache PopulateCache JavaScript |
api-config.js api-token-get.js translate-query.js translate-results.js |
| 分页 | 根据客户端提供的限制和偏移参数将 XML 响应消息分页 | assignMessage ExtractVariables ResponseCache VerifyApiKey XSL |
paginate.xslt |
| 响应缓存 | 演示如何在 Edge 上将天气预报缓存 10 分钟。 | ResponseCache AssignmentMessage |
无 |
| simple-python | 演示了以下简单场景：在 响应中附加 Python 脚本，以添加标头值。 |
脚本 (Python) | setHeader.py |
| soap | 演示了重写 WSDL 文件以响应包含查询参数 ?wsdl 的请求的 XSL 转换。 | assignMessage ExtractVariables 脚本 (Python) XSL |
计算 address.py fixwsdl.xsl |
| 流式传输 | 演示 HTTP 流式传输配置。 | 无 | 无 |
| target-reroute | 演示了如何使用 JavaScript 根据请求消息的内容动态选择目标网址。 | ExtractVariables JavaScript |
rewriteTargetUrl.js |
| twitter-mobile-timeline | 演示了如何使用 JavaScript 从推文中移除不需要的参数，从而简化 Twitter 时间轴，适用于资源受限的移动设备。 | AssignmentMessage JavaScript |
MobileTimeline.js |
| Twitter-oembed | 将时间轴响应（例如，从 constraints/user_timeline.json）转换为包含时间轴数据的 oEmbed 响应（富文本 HTML 内容）。 | AssignmentMessage JavaScript |
search-oembed.js |
| 变量 | 演示了如何根据传输以及 JSON 和 XML 消息内容提取和设置变量。 | AssignmentMessage ExtractVariables XMLToJSON |
min.js |
| xmltojson | 将响应数据从 XML 转换为 JSON。 | XMLToJSON JSONToXML |
无 |
|
|
XML 架构文件，在配置 API 代理、政策、API 产品以及开发者和应用配置文件时可用作参考。 |
||
|
|
包含一个部署工具 deploy.py，用于将 API 代理导入 Apigee Edge 上的组织，然后将其部署到指定的环境。 |
||
|
|
组织概况工具可检索组织设置，包括开发者、API 产品、虚拟主机、键值对映射等。它可用于备份组织的详细信息，或发现组织中的设置。 |
Apigee-127
如果您是一名程序员，Apigee-127 可帮助您开始使用 Node.js 和 Swagger 编写 API 代理代码。您还可以在 GitHub 上找到 a127 示例：https://github.com/apigee-127/a127-samples。
分享您的经历
在 Apigee 开发者论坛上分享您的体验。