適用於:所有 API 管理 層
修訂可讓您以受控且安全的方式變更 API。 當您想要進行變更時,請建立新的修訂。 然後,您可以編輯和測試 API,而不會打擾 API 取用者。 準備好後,您可以將修訂設定為當前版本。 同時,您可以選擇性地將項目張貼到變更記錄中,讓您的 API 取用者隨時了解您所做的變更。 變更記錄會發佈至您的開發人員入口網站。
備註
使用層不提供開發人員入口網站。
透過修訂,您可以:
- 安全地變更您的 API 定義和政策,而不會干擾您的生產 API。
- 在發佈變更之前先嘗試變更。
- 記錄您所做的變更,以便開發人員瞭解新增內容。
- 在發現問題時復原。
存取特定修訂
API 的每個修訂都可以使用特殊格式的 URL 來存取。
;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 使用者檢視。 您可以使用 Update-AzApiManagementApiRelease PowerShell cmdlet 修改變更記錄筆記。
謹慎
如果您要編輯 API 的非最新修訂,則無法變更下列屬性:
- 名稱
- 類型
- Description
- 需要訂閱
- API 版本
- API 版本說明
- 路徑
- 協定
這些屬性只能在目前版本修訂中變更。 如果您的編輯變更了非目前版本修訂中的任何這些性質,則會顯示錯誤訊息 Can't change property for non-current revision 。
離線修訂
修訂可以離線,這使得呼叫者即使嘗試透過其 URL 存取修訂也無法存取該修訂。 您可以使用 Azure 入口網站將修訂標示為離線。
備註
我們建議您在不使用修訂進行測試時將其離線。
版本和修訂
版本和修訂是不同的功能。 每個版本可以有多個修訂,就像非版本化 API 一樣。 您可以使用修訂而不使用版本,反之亦然。 通常,版本用於分隔具有重大變更的 API 版本,而修訂則可用於 API 的次要和非重大變更。
如果您的修訂有重大變更,或者您希望正式將修訂轉換為 Beta/測試版本,您可以從修訂建立版本。 使用 Azure 入口網站,在 [修訂] 索引標籤的修訂內容功能表上選取 [從修訂建立版本]。