REST API支持版本管理,本文介紹如何通過控制臺添加API版本,并切換至目標API版本。
前提條件
已完成REST API創建并添加接口。具體操作,請參見創建REST API并添加接口。
使用背景
在REST API中進行版本管理是一項重要的實踐,它有助于保持API的向后兼容性,并簡化未來的維護和升級。它允許API隨著時間的推移而演化,同時保持對舊版本的支持。
添加API版本
登錄云原生API網關控制臺。
在左側導航欄,單擊API管理,并在頂部菜單欄選擇地域。
在API列表中,單擊目標API,進入目標API詳情頁,單擊頁面右上角的
。配置版本信息,并單擊確認進行添加。
配置項
說明
版本號
相同API名稱下,以版本號進行區分。
使用方式
支持Path、Query、Header三種方式。
說明選擇使用方式為Query時,需要配置參數項添加Query。
選擇使用方式為Header時,需要配置參數項添加Header。
使用Path時,需要完整訪問路徑為:/API基本路徑/版本號/接口路徑。
使用Query時,完整訪問路徑為:/API基本路徑/接口路徑,請求參數中需要配置參數項添加Query為版本號。
使用Header時,完整訪問路徑為:/API基本路徑/接口路徑,請求頭中需要配置參數項添加Header為版本號。
切換API版本
登錄云原生API網關控制臺。
在左側導航欄,選擇API管理,并在頂部菜單欄選擇地域。
在API列表中,單擊目標API,進入目標API詳情頁,單擊頁面左上角的版本進行切換。
文檔內容是否對您有幫助?