創建完成的API,支持發布到不同的環境。API只有在發布到環境后,才支持被調用。API網關支持查看API發布歷史(如版本、發布說明、發布時間和發布環境),并支持回滾到不同的API歷史版本。
說明
已發布的API,在修改信息后,需要重新發布才能將修改后的信息同步到環境中。
同一個API在每個環境中最多記錄10條最新的發布歷史。
發布API
步驟 1 進入API網關控制臺頁面。
步驟 2 根據實際業務在左側導航欄上方選擇實例。
步驟 3 在左側導航欄選擇“API管理 > API分組”。
步驟 4 單擊 分組名稱 。
步驟 5 在“API運行”頁面,選擇待發布的API,單擊“發布最新版本”。
步驟 6 選擇API需要發布到的環境,并填寫發布說明。
說明
如果API在選擇的環境中已發布,再次發布即為覆蓋該環境的API。
如果在選擇的環境時沒有自己需要的環境,可以創建一個自己需要的環境。
步驟 7 單擊“確定”,API發布成功后,“發布最新版本”按鈕左上角的紅色感嘆號消失。
已發布的API因為其他原因需要暫停對外提供服務,可以暫時將API從相關環境中下線。該操作將導致此API在指定的環境無法被訪問,請確保已經告知使用此API的用戶后,選擇待下線的API,單擊“下線”即可。
查看發布歷史
步驟 1 在“API運行”頁面,選擇待查看發布歷史的API。
步驟 2 單擊“更多 > 發布歷史”。
步驟 3 在版本所在行,單擊“查看版本”,彈出此版本詳細信息對話框。
查看API基本信息、API請求、后端請求、入參定義、參數映射、常量參數和返回結果。
步驟 4 如果想要設置之前版本為當前版本,則在版本所在行,單擊“切換至此版本”,彈出“切換至此版本”對話框。
單擊“確定”,完成版本的切換。此時版本號旁邊顯示“當前版本”,說明設置成功。
API調用者調用此API時,API參數為“當前版本”設置的參數,不是最后一次編輯保存的API參數。
例如,2018年8月1日發布在RELEASE環境的API匹配模式設置為“絕對匹配”,2018年8月20日修改API匹配模式設置為“前綴匹配”,并發布到RELEASE環境。然后設置2018年8月1日發布的版本為當前版本,此時API調用者調用此API時,API的匹配模式為“絕對匹配”。