您正在查看 Apigee Edge 文档。
前往 Apigee X 文档。 信息
2015 年 9 月 8 日(星期二),我们发布了面向私有云的 Apigee Edge 开发者服务门户的季度版本。
以前的产品名称“Apigee Edge 本地开发者服务门户”或“OPDK”现已更名为“适用于私有云的 Apigee Edge 开发者服务门户”。
如有疑问,请与 Apigee 客户支持团队联系。
如需查看所有 Apigee Edge 版本说明的列表,请参阅 Apigee 版本说明。
门户的 Apigee Edge 要求
如果您要将此版本的门户连接到安装的 Edge for Private Cloud,则必须将其连接到 4.15.07.00 或更高版本,以确保支持所有 SmartDocs 功能。如需了解详情,请参阅 4.15.07.00 - Apigee Edge for Private Cloud 版本说明。
新功能
SmartDocs 正式版
SmartDocs 已从 Beta 版阶段过渡至正式版阶段。更新和新功能包括:
- 支持 Swagger 2.0,包括通过文件或网址导入,以及对自定义命名安全对象的支持。
- 改进了用于生成 SmartDocs 的模板的视觉设计。
- 开发者门户中的易用性和工作流改进,可通过 Drupal 中的“Content”>“SmartDocs”菜单使用。
- 以前称为“自定义令牌”的身份验证方式现已更名为“API 密钥”。
- 在修订级别定义的身份验证“安全”对象。
- 在模板级别配置客户端身份验证。新修订版不再重置任何预配置的 SmartDocs 客户端凭据。
如需了解更多功能说明,请参阅这篇博文。
如需查看 SmartDocs 文档,请参阅使用 SmartDocs 记录 API。
SmartDocs 升级流程
如果您在 Beta 版期间就已在使用 SmartDocs,则需要在开发者门户中升级 SmartDocs,才能使用正式版中的新功能和特性。
在开发者门户中已发布的所有 SmartDocs 页面都将继续正常运行,但您必须先按照更新流程操作,然后才能修改或发布对现有或新页面所做的任何更改。
请注意,虽然您可以在开发者门户中呈现和发布 SmartDocs,但 SmartDocs 是根据 Apigee Edge API 管理服务中 API 模型生成的。您在 Edge 中对 API 模型所做的任何更改都会在您的所有 Pantheon 环境中生效(类似于开发者在 Pantheon 环境中的存在方式)。
如何从 SmartDocs Beta 版升级到正式版
- 在 Pantheon 上的开发或测试环境中更新并测试 15.05.27 版。
- 创建一个新模型来替换您一直在使用的任何现有 API 模型。
- 如果您之前导入了 Swagger 或 WADL 文档,请将其重新导入到新修订版中。
- 如果您一直在通过 SmartDocs 模块维护 API 模型,请导出为 SmartDocs JSON 格式,然后使用文件附件导入到新模型中。
- 设置模型修订版的安全属性。在内容 > SmartDocs > 模型页面上,选择安全设置。
- 在“操作”列中点击设置,然后在“模型设置”页面(内容 > SmartDocs)中查看所有预配置的身份验证。
- 更新所有自定义模板以使用 v6 版 CSS 和 JS 资源,并进行更改以反映所有新对象名称(例如 authSchemes 和 apiSchema)。如需了解如何更新 SmartDocs 模板,请参阅使用 SmartDocs 为 API 编写文档。
- 重新渲染并发布模型修订版。
- 验证新文档后,请将生产门户更新为 15.05.27 版。
如果您是 Edge 企业版客户,并且对升级流程有疑问或顾虑,请发送电子邮件至 marsh@apigee.com 和 cnovak@apigee.com。否则,请使用 Apigee 社区获取最妥善的回复。
已修复 Bug
此版本中修复了以下 bug。
问题 ID | 说明 |
---|---|
DEVSOL-487 | 管理员应能够在创收中配置日期格式 现在,您可以在“创收”的“创收设置”下配置日期格式,以便使用欧洲和美国日期格式。 |
DEVSOL-584 | 首次使用时不记住路径参数 系统不一定会记住发起调用时的路径参数。 |
DEVSOL-603 | “存在冲突的方案”页面格式欠佳 现在,当用户购买与现有方案重叠的方案时,系统会向用户显示格式良好的页面。 |
DEVSOL-709 | SmartDocs:在发送包含空值的请求后,网址模板参数不可修改 修复了以下问题:在从 SmartDocs 发送请求后,删除方法文档中的模板参数会导致模板参数不可修改。 |
DEVSOL-723 | 在 SmartDocs 导入失败时显示方便用户理解的消息 |
DEVSOL-1013 | 使开发者门户用户电子邮件地址可修改 修改个人资料页面中的电子邮件地址字段将不再处于停用状态,开发者可以更改其电子邮件地址。 |
DEVSOL-1244 | 不为 OPDK 版本启用环境指示器模块 |
DEVSOL-1273 | “DevConnect Mint”在“模块”列表中显示两次 在“模块”下,系统会显示两次“Dev Connect Mint”。此问题现已解决。 |
DEVSOL-1313 | 支持通过 JSON/YAML 文件或网址导入 Swagger 和 WADL 现在,您可以通过网址导入 WADL 文件,也可以上传 Swagger 文件。 |
DEVSOL-1339 | 更改了 SmartDocs 管理菜单位置 SmartDocs 现在位于“内容”菜单下,SmartDocs 设置位于“设置”管理菜单下。 |
DEVSOL-1340 | 在发布 GA 版时移除 Beta 版 |
DEVSOL-1390 |
PHP SDK Edge 库已更新,以修复调用 __toString() 时出现的问题 严重错误:在 /Applications/MAMP/htdocs/ordnance/docroot/profiles/apigee/libraries/mgmt-api-php-sdk/Apigee/Mint/DeveloperRatePlan.php 的第 221 行中,对非对象调用成员函数 format() 这是一个 bug,仅会影响调用 toString() 方法的自定义代码的创收客户。 |
DEVSOL-1398 | 安装时导入 SmartDocs Petstore 模型,而不会提示用户 现在,SmartDocs 会在网站安装期间导入 Petstore Swagger 示例 (http://petstore.swagger.io/v2/swagger.json),而不是天气模型,以便提供更详尽的 SmartDocs 使用示例。 |
DEVSOL-1407 | 开发者众多时,Cron 会失败 运行 Drupal Cron 时,大量开发者会导致超时问题。如果组织有超过 200 位用户,系统现在会使用批处理。 |
DEVSOL-1410 | 安装开发者门户时连接错误不明显 在 Edge 管理连接不起作用时,为安装程序添加了更明确的错误消息,以最大限度地减少排查问题。 |
DEVSOL-1422 | 从 Apigee 配置文件中移除了 SMTP 配置表单 安装过程中不再询问您是否要配置 SMTP,而是在安装完成后按照标准 Drupal 做法启用 SMTP 模块并正确配置它。 |
DEVSOL-1427 |
向 Devconnect 开发者应用模块添加了钩子,以允许更改分析数据 # hook_devconnect_developer_apps_analytics_chart_data_alter() # hook_devconnect_developer_app_analytics_datapoints_params_alter() # hook_devconnect_developer_app_analytics_datapoints_alter() 这些方法允许自定义模块更改开发者应用分析图表。 |
DEVSOL-1464 | 保存模型的身份验证设置时发生严重错误 现在,删除安全架构时,系统会显示一个复选框,用于选择是否也需要删除关联的模板身份验证架构。 |
DEVSOL-1470 | 创建“API”菜单链接和相应的视图 开发者门户 SmartDocs 现在默认在名为“API”的主菜单中提供了指向 SmartDocs 呈现的文档的链接,该链接会指向具有已发布方法的任何模型。 |
DEVSOL-1486 | SmartDocs 调用可以使用预定义密钥进行身份验证 支持使用预先提供的 API 密钥和用户提供的 API 密钥进行身份验证。 |
DEVSOL-1499 | SmartDocs 参数说明中未解析 HTML 代码 现在,SmartDocs 参数说明中会解析 HTML 代码。 |
DEVSOL-1507 | 无法使用“添加方法”向 API 添加多个参数 现在,您可以在修改方法时向 SmartDocs API 添加多个参数。 |
DEVSOL-1509 | 找不到用于修改 SmartDocs API 的“示例”字段 现在,您可以在修改 SmartDocs 页面时设置“正文 MIME 类型”“正文文档”和“正文示例”。 |
DEVSOL-1534 | SmartDocs 输出中未填充 Content-type 现在,SmartDocs 方法页面中会填充 Content-type。 |
DEVSOL-1554 | 创收功能中的日期比较无效 在启用了创收功能的开发者门户的“已购买方案”标签页中,对于开始日期在未来的方案,系统从未显示“取消”按钮, |
DEVSOL-1556 | 发货时附带的 Drupal 模块是旧版本 media_youtube 和 features 模块已更新为最新版本。 |
DEVSOL-1558 | PetStore 示例的 SmartDocs 方法页面无法呈现 在全新安装后,示例 SmartDocs PetStore 方法现在可以正确呈现。 |
DEVSOL-1562 | 为每个 SmartDocs 模型生成视图 创建新模型时,系统会默认为该模型创建一个新视图。 |
DEVSOL-1565 | 修改 SmartDocs 方法会生成严重错误 修复了修改 SmartDocs 方法有时会生成错误的问题。 |
DEVSOL-1567 | “添加模型”显示在顶部管理菜单中 修复了“添加模型”菜单项显示在顶部管理菜单中的问题。 |
DEVSOL-1576 | API 文档视图显示的是型号名称,而不是显示名称 点击菜单中的“API”时显示的 API 文档页面显示的是型号的内部名称,而不是显示名称。如果您要更新到该版本,并且更改了此视图,则需要按照以下步骤还原视图,才能查看这些更改:# 以管理员身份登录 # 依次前往“结构”>“视图”# 点击“SmartDocs 模型”上“修改”旁边的下拉菜单,查看所有操作。# If you see "revert", then you have overwritten the code w/your own change. 点击“还原”将视图恢复为默认状态。请注意,这会移除您对此视图所做的所有更改。 |
DEVSOL-1578 | 在网站安装时渲染 Weather 和 Petstore 模型 在新的网站上导入 Petstore 和 Weather SmartDocs 模型。 |
DEVSOL-1584 | 无法购买方案 修复了以下问题:如果您使用的是 Apigee 响应式主题或 Apigee 响应式主题的子主题,则创收方案购买表单无法提交 Cloud 版本 15.05.27.00 和 15.06.08.00。 |
DEVSOL-1597 | 无法更改开发者超时设置 修复了 Edge 连接超时设置未正确应用的 bug。 |
DEVSOL-1620 |
“我”“环境指示器”和“功能”模块升级 https://www.drupal.org/project/me https://www.drupal.org/project/environment_indicator |
DEVSOL-1648 | 确保 arg_separator.output 为“&”以防止 reCAPTCHA 中断 修复了导致 Google reCAPTCHA 无法正常使用的平台相关问题。 |
DEVSOL-1651 | 如果未启用 SmartDocs 模块,Apigee 基础主题会失败 apigee_base 主题不再依赖于 SmartDocs 模块是否处于启用状态。 |
DEVSOL-1654 |
提高了 admin_views 的版本以采用重要的安全修复程序
|