您正在查看 Apigee Edge 文档。
前往 Apigee X 文档。 信息
Apigee Edge API 示例包含 API 代理、政策、代码和工具示例，这些示例说明了下文所述的 Apigee Edge API 服务的功能。
如需了解如何使用这些示例，请参阅使用 API 代理示例。
在实践中学习
想要快速上手并开始建立关于 Apigee Edge 的扎实知识库？我们在 GitHub 上提供了一个“学习边缘”示例库，可让您快速部署、调用和跟踪一些示例代理，从最简单的代理开始，然后再转到演示 API 密钥验证、配额、响应缓存、故障处理等功能的代理。
克隆代码库并设置环境（只需几分钟时间）后，您就可以在不到一分钟的时间内试用每个示例。由于每个样本都会创建同一代理的新修订版本，因此您的环境不会因大量样本而变得杂乱无序。您可以随时切换修订版、在管理界面中重新部署其他修订版，以及查看代理代码。每个示例的 readme 中还会简要介绍该示例的用途和设置方式。
欢迎试用！https://github.com/apigee/api-platform-samples/tree/master/learn-edge
文档实战宝典示例
我们为 API 代理实战宝典主题提供了一组示例。
| 名称 | 说明 | 政策类型 | 资源 |
|---|---|---|---|
| javascript-cookbook | 演示了一个简单的 JavaScript 代码段，该代码段会从变量添加 HTTP 标头，将 XML 格式的天气预报从 JSON 转换为 XML，并为移动客户端修剪内容。 | minimize.js setHeaders.js |
|
| javascript-mashup-cookbook | 一个完整的 JavaScript 应用，用于调用公共 API、合并结果并为客户端应用生成丰富的响应。请注意，此 API 代理实现了与 policy-mashup 相同的功能，这表明可以使用不同的方法来解决同一问题。 | JavaScript | MashItUp.js |
| java-hello | 简单的 hello world Java callout。 | JavaCallout | JavaHello.java |
| java-cookbook | 将响应内容和标头转换为大写。 | JavaCallout |
ResponseUppercase.java |
| java-properties | 演示如何在 JavaCallout 中使用属性。 | JavaCallout | JavaProperties.java |
| java-error | 演示了您可以在 Java 宣传信息代码中使用的错误处理模式。 | JavaCallout | JavaError.java |
| policy-mashup-cookbook | 一个完整的应用，它使用政策组合调用两个公共 API、合并结果，并为客户端应用生成丰富的响应。注意：此 API 代理实现了与 javascript-mashup 相同的功能，这表明可以使用不同的方法来解决同一问题。 | AssignMessage ServiceCallout ExtractVariables Javascript XMLToJSON |
GenerateResponse.js |
API 代理示例
以下 API 代理位于 GitHub 中，其中的“自述”页面详细介绍了这些示例。如果您有兴趣了解特定政策在示例中的运作方式，请在下方的“政策类型”列中查找您感兴趣的政策，然后点击“名称”列中的示例名称。（这些政策会链接到文档中相应的参考页面。）
参考文档和工具
除了上表中的文档食谱示例和示例代理之外，Edge GitHub 示例还包含以下资源：
| 名称 | 说明 | 政策类型 | 资源 |
|---|---|---|---|
| regex-protection | 正则表达式威胁防护政策可保护您的后端 API 和微服务免受 SQL 注入攻击。 | 不适用 | |
| oauth-validate-key-secret | 您正在实现 OAuth 密码授权类型流程。您需要先在 Edge 上验证应用客户端密钥和密钥，然后才能调用外部身份提供程序来验证用户的凭据。 | OAuthV2、其他 | 不适用 |
| condition-pattern-matching | 借助此代理，您可以轻松试用和测试 API 代理流中的条件语句。 | AssignMessage | 不适用 |
| access-entity | 展示如何从 Apigee Edge 数据存储区检索实体的配置文件。 | AssignMessage AccessEntity ExtractVariables |
无 |
| apikey | 实现简单的 API 密钥验证 | VerifyAPIKey AssignMessage 配额 |
无 |
| async-callout | 演示使用 JavaScript httpClient 的简单异步 callout。 | JavaScript | assemble_response.js callout.js |
| base64encoder | 演示如何在 API 代理中的 JavaScript 资源中调用 JavaScript 包含内容。 | AssignMessage JavaScript |
core-min.js enc-utf16-min.js enc-base64-min.js encodeAuthHeader.js |
| conditional-policy | 实现简单的条件政策强制执行。如果请求包含 HTTP 标头 responsetime:true，则政策会执行一个 Python 脚本，该脚本会将一组性能指标作为 HTTP 标头添加到响应消息中 | 脚本 (Python) | timer.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 AssignMessage ExtractVariables ServiceCallout RaiseFault |
无 |
| oauth-verify-accesstoken | 演示了配置为验证 OAuth 2.0 访问令牌和验证配额的 API 代理。 | VerifyAccessToken 配额 |
无 |
| oauth10a-3legged | 演示了三足式 OAuth 1.0a 配置。 | GenerateAceessToken GenerateRequestToken ServiceCallout VerifyAccessToken |
无 |
| outbound-oauth | 使用 Microsoft Azure translator API 来翻译 Twitter 微博。为此，该方法会发出出站调用以获取 OAuth 访问令牌，然后使用 API 服务缓存政策缓存该令牌，并在每次发出出站调用时重复使用缓存的令牌。此外，还包括用于调用 API 代理的演示浏览器应用。 | AssignMessage LookupCache PopulateCache Javascript |
api-config.js api-token-get.js translate-query.js translate-results.js |
| 分页 | 根据客户端提供的 limit 和 offset 参数分页显示 XML 响应消息 | AssignMessage ExtractVariables ResponseCache VerifyApiKey XSL |
paginate.xslt |
| response-cache | 演示如何在 Edge 上将天气预报缓存 10 分钟。 | ResponseCache AssignMessage |
无 |
| simple-python | 演示了在响应中附加 Python 脚本的简单场景，该脚本会向响应添加标头值。 |
脚本 (Python) | setHeader.py |
| soap | 演示了 XSL 转换，该转换会重写 WSDL 文件，以响应包含查询参数 ?wsdl 的请求。 | AssignMessage ExtractVariables 脚本 (Python) XSL |
calculateaddress.py fixwsdl.xsl |
| 流式 | 演示 HTTP 流式传输配置。 | 无 | 无 |
| target-reroute | 演示了如何使用 JavaScript 根据请求消息的内容动态选择目标网址。 | ExtractVariables JavaScript |
rewriteTargetUrl.js |
| twitter-mobile-timeline | 演示了如何使用 JavaScript 从推文中移除不需要的参数，从而获得简化版的 Twitter 时间轴，使其适合资源受限的移动设备。 | AssignMessage JavaScript |
MobileTimeline.js |
| twitter-oembed | 将时间轴响应（例如来自 statuses/user_timeline.json）转换为 oEmbed 响应，其中包含作为富 HTML 内容的时间轴数据。 | AssignMessage JavaScript |
search-oembed.js |
| 变量 | 演示如何根据传输、JSON 和 XML 消息内容提取和设置变量。 | AssignMessage ExtractVariables XMLToJSON |
minimize.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 开发者论坛上分享您的体验。