你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
适用于:所有 API 管理层级
修订允许你以受控且安全的方式更改 API。 如果要进行更改,请创建新的修订。 然后,无需干扰 API 使用者即可编辑和测试 API。 准备就绪后,即可更新修订版本至当前的状态。 同时,可以选择将条目发布到更改日志,使 API 使用者随时了解所做的更改。 更改日志将发布到开发人员门户。
注释
在“消耗”层中,开发人员门户不可用。
通过修订,您可以:
- 安全地更改 API 定义和策略,而不会干扰生产 API。
- 在发布这些更改之前测试这些更改。
- 记录所做的更改,以便开发人员可以了解新增功能。
- 如果发现问题,请回滚。
访问特定修订
您可以通过使用特殊格式的 URL 访问您的 API 的每次修订。 追加 ;rev={revisionNumber} 到 API URL 末尾,但在查询字符串之前,以访问该 API 的特定修订。 例如,可以使用此 URL 访问 API 的 customers 修订版 3:
https://apis.contoso.com/customers;rev=3/leads?customerId=123
默认情况下,每个修订与当前修订具有相同的安全设置。 如果要为每个修订应用不同的安全性,可以有意更改特定修订的策略。 例如,你可能想要添加 IP 筛选策略 ,以防止外部调用方访问仍在开发的修订。
注释
;rev={id}必须被追加到 API ID 上,而不是 URI 路径上。
当前修订
可以将单个修订设置为 当前 修订。 此修订是用于未在 URL 中指定显式修订号的所有 API 请求。 要回滚到以前的修订,可以通过将该修订设置为当前版本来实现。
可以使用 Azure 门户将修订设置为当前版本。 如果使用 PowerShell,可以使用 New-AzApiManagementApiRelease cmdlet。
修订说明
创建修订版时,可以为自己的跟踪目的设置说明。 不会向 API 用户显示说明。
将修订设置为当前版本时,还可以选择指定公共更改日志注释。 更改日志包含在开发人员门户中,供 API 用户查看。 可以使用 PowerShell cmdlet 修改更改日志注释 Update-AzApiManagementApiRelease 。
注意
如果要编辑 API 的非当前修订,则无法更改以下属性:
- Name
- 类型
- Description
- 需要订阅
- API 版本
- API 版本说明
- 路径
- 协议
只能在当前修订中更改这些属性。 如果编辑更改了非当前修订中的任何一个属性,则会显示错误消息 Can't change property for non-current revision 。
在离线状态下获取版本
修订版可以脱机使用,这使得调用方无法进行访问,即使试图通过其 URL 访问修订版也是如此。 可以使用 Azure 门户将修订标记为脱机。
注释
建议在不使用修订版进行测试时将其脱机。
版本和修订
版本和修订是不同的功能。 每个版本可以有多个修订,就像非版本化 API 一样。 可以在不使用版本的情况下使用修订,也可以以其他方式使用修订。 通常,版本用于将 API 版本与中断性变更分开,而修订可用于 API 的次要和非中断性变更。
如果修订版有中断性变更,或者你想要将其正式转换为 beta/测试版本,则可根据修订版创建一个版本。 使用 Azure 门户,在“修订”选项卡上的修订上下文菜单中选择“从修订创建版本”。