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

您正在查看的是 Apigee Edge 文档。
转到 Apigee X 文档
信息

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

如果您有任何疑问,请转到 Apigee 客户支持

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

新功能

SmartDocs 正式版

SmartDocs 正从 Beta 版升级到正式版。更新和新功能包括:

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

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

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

SmartDocs 升级过程

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

已在开发者门户中发布的所有 SmartDocs 页面都将继续正常运行,但您必须按照更新流程操作,才能修改现有页面或新页面或发布任何更改。

请注意,虽然您可以在开发者门户内渲染和发布 SmartDoc,但 SmartDocs 是由 Apigee Edge API 管理服务中的 API 模型生成的。您在 Edge 中对 API 模型所做的任何更改在您的所有 Pantheon 环境中都相同(类似于开发者跨 Pantheon 环境中的存在方式)。

从 SmartDocs Beta 版升级到正式版

  1. 在 Pantheon 的devdev环境中更新并测试 15.05.27 版本。
  2. 创建新模型以替换您我们一直在使用的任何现有 API 模型。
    • 如果您一直在导入 Swagger 或 WADL 文档,请再次将其导入新的修订版本。
    • 如果您一直在通过 SmartDocs 模块维护 API 模型,请将模型导出为 SmartDocs JSON,并使用文件附件导入新模型。
  3. 设置模型修订版本的安全属性。在内容 > SmartDocs > 模型页面上,选择安全设置
  4. 点击“操作”列中的设置,在模型设置页面(内容 > SmartDocs)中检查所有预配置的身份验证。
  5. 将所有自定义模板更新为使用 v6 的 CSS 和 JS 资源,并进行更改以反映所有新的对象名称,例如 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 修改 Dev Portal 用户的电子邮件地址
修改个人资料页面中的电子邮件地址字段将不再停用,并且开发者可以更改其电子邮件地址。
DEVSOL-1273 “DevConnect Mint”在“模块”列表中出现了两次
在“模块”下,“Dev Connect Mint”出现了两次。此问题现已解决。
DEVSOL-1313 支持 Swagger 和 WADL 的 JSON/YAML 文件或网址导入
现在可以通过网址导入 WADL 文件,并且可以上传 Swagger 文件。
DEVSOL-1339 更改 SmartDocs“管理”菜单的位置
SmartDocs 现在位于内容菜单下,而智能文档设置位于设置管理菜单下。
DEVSOL-1340 发布正式版时移除 Beta 版
SmartDocs 现在位于内容菜单下,智能文档设置位于设置管理菜单下。
DEVSOL-1390 PHP SDK Edge 库已更新,解决了调用 __toString() 这一问题。
更新了 PHP SDK Edge 库,解决了对 DeveloperRatePlan 对象调用 __toString() 会导致以下错误的问题:{quote} 致命错误:对成员函数格式调用对非 /Applications/MAMP/htdocs/ordnance/apigeeRate only/doc 中的非对象调用 __toString() 时会出现此问题
DEVSOL-1398 在安装时导入 SmartDocs Petstore 模型,而不提示用户
SmartDocs 现在会在网站安装期间导入 petstore Swagger 示例 (http://petstore.swagger.io/v2/swagger.json),而不是天气模型,以便获得更详尽的 SmartDocs 使用示例。
DEVSOL-1407 如果有许多开发者,Cron 会失败
运行 Drupal Cron 时,大量开发者导致了超时问题。当一个组织中的用户超过 200 人时,现在使用批处理。
DEVSOL-1470 创建“API”菜单链接和相应视图
Dev Portal SmartDocs 现在默认包含指向主菜单中名为“API”的 SmartDocs 呈现的文档的链接,该链接会链接到具有已发布方法的任何模型。

已知问题

此版本包含以下已知问题:

问题 ID 说明
DEVSOL-1558
新安装时,Petstore 示例 SmartDocs 方法页面无法正确呈现
新安装时,SmartDocs 中的 Petstore 方法页面示例无法正确呈现。要解决此问题,请执行以下操作:
  1. 在 Drupal 菜单中,依次选择内容 > SmartDocs
  2. 选择“Petstore Example”模型。
  3. Update Options 下选择 Render and publish nodes
  4. 选中选择 / 取消全选复选框以选择所有节点。
  5. 点击更新

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