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 中的“Content”>“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. 更新所有自定义模板以使用 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 使开发者门户用户电子邮件地址可修改
修改个人资料页面中的电子邮件地址字段将不再处于停用状态，开发者可以更改其电子邮件地址。
DEVSOL-1273 “DevConnect Mint”在“模块”列表中显示两次
在“模块”下，系统会显示两次“Dev Connect Mint”。此问题现已解决。
DEVSOL-1313 支持通过 JSON/YAML 文件或网址导入 Swagger 和 WADL
现在，您可以通过网址导入 WADL 文件，也可以上传 Swagger 文件。
DEVSOL-1339 更改了 SmartDocs 管理菜单位置
SmartDocs 现在位于“内容”菜单下，SmartDocs 设置位于“设置”管理菜单下。
DEVSOL-1340 在 GA 中移除“Beta 版”标记
现在，SmartDocs 位于“内容”菜单下，SmartDocs 设置位于“设置”管理菜单下。
DEVSOL-1390 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}此 bug 仅会影响调用 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”菜单链接和相应的视图
开发者门户 SmartDocs 现在默认在名为“API”的主菜单中提供了指向 SmartDocs 呈现的文档的链接，该链接会指向具有已发布方法的任何模型。

已知问题

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

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

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