15.05.27.00 - Apigee 开发者服务门户版本说明

您正在查看 Apigee Edge 文档。
前往 Apigee X 文档
信息

2015 年 6 月 2 日(星期二),我们发布了新版 Apigee 开发者服务门户的云版本。

如果您有任何疑问,请与 Apigee Edge 支持团队联系。

如需查看所有 Apigee Edge 版本说明的列表,请参阅 Apigee 版本说明

新功能

SmartDocs 正式版

SmartDocs 即将从 Beta 版过渡到正式版。更新和新功能包括:

  • 支持 Swagger 2.0,包括通过文件或网址导入,还支持自定义命名的安全对象。
  • 改进了生成 SmartDocs 的模板中的视觉设计。
  • 开发者门户中的可用性和工作流增强功能,可通过 Drupal 中的“内容”>“SmartDocs”菜单访问。
  • 之前称为“自定义令牌”的身份验证现在称为“API 密钥”。
  • 在修订版本级别定义的身份验证“安全”对象。
  • 在模板级配置客户端身份验证。新修订版本不再重置任何预配置的 SmartDocs 客户端凭据。

如需了解更多功能说明,请参阅这篇博文

如需查看 SmartDocs 文档,请参阅使用 SmartDocs 记录 API

SmartDocs 升级流程

如果您在 Beta 版期间已在使用 SmartDocs,那么正式版中的新功能和新功能需要您在开发者门户中升级 SmartDocs。

您在开发者门户中已发布的任何 SmartDocs 页面都将继续正常运行,但您必须先完成更新流程,然后才能编辑或发布对现有页面或新页面的任何更改。

请注意,虽然您可以在开发者门户中呈现和发布 SmartDocs,但 SmartDocs 是根据 Apigee 的 Edge API 管理服务中的 API 模型生成的。您在 Edge 中对 API 模型所做的任何更改都将在所有 Pantheon 环境中保持一致(类似于开发者在所有 Pantheon 环境中保持一致)。

从 SmartDocs Beta 版升级到正式版

  1. 在 Pantheon 的开发测试环境中更新并测试 15.05.27 版本。
  2. 创建新模型以替换您一直在使用的任何现有 API 模型。
    • 如果您之前导入过 Swagger 或 WADL 文档,请将它们再次导入到新的修订版本中。
    • 如果您一直通过 SmartDocs 模块维护 API 模型,请导出为 SmartDocs JSON,然后使用文件附件导入到新模型中。
  3. 设置模型修订版本的安全属性。在内容 > SmartDocs > 模型页面上,选择安全设置
  4. 点击“操作”列中的设置,在模型设置页面(内容 > SmartDocs)中检查所有预配置的身份验证。
  5. 更新所有自定义模板,以使用 CSS 和 JS 资源的版本 6,并进行更改以反映所有新对象名称,例如 authSchemes 和 apiSchema。如需了解如何更新 SmartDocs 模板,请参阅使用 SmartDocs 记录 API
  6. 重新渲染并发布模型修订版本。
  7. 验证新文档后,将您的生产门户更新到 15.05.27 版本。

如果您是 Edge 企业客户,并且对升级过程有疑问或疑虑,请发送电子邮件至 marsh@apigee.com 和 cnovak@apigee.com。否则,请使用 Apigee 社区,以便获得最佳解答。

已修复 Bug

此版本中修复了以下 bug。

问题 ID 说明
DEVSOL-487 创收中的日期格式应可由管理员配置
现在,您可以在创收中的创收设置下配置日期格式,以使用欧洲和美国日期格式。
DEVSOL-603 “冲突方案”页面格式不正确
现在,当用户购买与现有方案重叠的方案时,系统会以美观的格式向用户显示相应页面。
DEVSOL-642 将客户级配置从安全设置移至模板设置
DEVSOL-709 SmartDocs:在发送空值的请求后,网址模板参数无法编辑
修复了以下问题:在方法文档中删除模板参数后,从 SmartDocs 发送请求会导致模板参数无法编辑。
DEVSOL-1013 使开发者门户网站用户电子邮件地址可修改
“修改个人资料”页面中的电子邮件地址字段将不再处于停用状态,开发者可以更改自己的电子邮件地址。
DEVSOL-1273 “DevConnect Mint”在模块列表中显示两次
在“模块”下,“Dev Connect Mint”显示了两次。此问题现已解决。
DEVSOL-1313 支持通过 JSON/YAML 文件或网址导入 Swagger 和 WADL
现在可以通过网址导入 WADL 文件,也可以上传 Swagger 文件。
DEVSOL-1339 更改 SmartDocs 管理员菜单位置
SmartDocs 现在位于内容菜单下,而 SmartDocs 设置位于设置管理员菜单下。
DEVSOL-1340 从 Beta 版过渡到正式版时移除 Beta 版
SmartDocs 现在位于内容菜单下,而 SmartDocs 设置位于设置管理菜单下。
DEVSOL-1390 PHP SDK Edge 库已更新,以修复调用 __toString() 时出现的问题
PHP SDK Edge 库已更新,以修复在 DeveloperRatePlan 对象上调用 __toString() 时出现的问题,该问题会导致以下错误:{quote} Fatal error: Call to a member function format() on a non-object in /Applications/MAMP/htdocs/ordnance/docroot/profiles/apigee/libraries/mgmt-api-php-sdk/Apigee/Mint/DeveloperRatePlan.php on line 221 {quote} 这是一个仅影响具有调用 toString() 方法的自定义代码的创收客户的 bug。
DEVSOL-1398 在安装时导入 SmartDocs Petstore 模型,而不提示用户
SmartDocs 现在在网站安装期间导入 petstore swagger 示例 (http://petstore.swagger.io/v2/swagger.json),而不是天气模型,以便提供更全面的 SmartDocs 使用示例。
DEVSOL-1407 当开发者数量较多时,Cron 会失败
运行 Drupal cron 时,大量开发者导致了超时问题。当组织的用户数量超过 200 时,系统现在会使用批处理流程。
DEVSOL-1470 创建“API”菜单链接和相应视图
开发者门户 SmartDocs 现在默认在主菜单中提供指向 SmartDocs 呈现的文档的链接,该链接名为“API”,可链接到任何具有已发布方法的模型。

已知问题

此版本存在以下已知问题:

问题 ID 说明
DEVSOL-1558
在全新安装中,Petstore 示例 SmartDocs 方法页面无法正确呈现
SmartDocs 中的示例 Petstore 方法页面在新安装中无法正确呈现。如需解决此问题,请执行以下操作:
  1. 在 Drupal 菜单中,依次选择 Content > SmartDocs
  2. 选择“Petstore 示例”模型。
  3. 更新选项下,选择渲染和发布节点
  4. 点击全选 / 取消全选复选框以选择所有节点。
  5. 点击更新

节点现在应该可以正常渲染了。