API創建完成后,您可以對API進行版本管理、轉交負責人等操作。本文為您介紹如何管理API。
API列表入口
在Dataphin首頁的頂部菜單欄,選擇服務 > 開發。
在左上角選擇服務項目,再在左側導航欄選擇API服務 > API,在API列表頁面。
您可根據API的名稱或ID搜索目標API,也可以快捷篩選我的API,或者根據API類型、API分組篩選目標API。
API列表為您展示已創建的API,包括API的名稱、API類型、API分組、應用數、負責人、模式、當前狀態、運行環境、發布版本、權限信息、發布信息等API詳情。
您可以在目標API的操作列表執行如下操作。
操作項
描述
發布
單擊操作列下的發布圖標,在API發布對話框中,選擇需要發布的已提交版本,將API發布至生產環境中,詳情參見步驟二:發布API。
說明若線上已有發布的版本,則API發布新版本到線上的過程中會對參數進行校驗,包括新增必填請求參數、刪減請求參數、刪減返回參數、變更請求參數的數據類型。
新版本發布到線上會影響API的調用,您可以在項目中設置不同的發布管控機制,在API發布時會根據其所屬項目的配置進行阻塞或發布,詳情請參見創建及管理服務項目。
編輯
單擊操作列下的編輯圖標,進入編輯API頁面。
說明系統默認進入API最新版本的編輯頁面,若需修改API的其他版本,您可以在編輯頁面的右上角切換API版本對不同版本進行編輯。
若該API的最新版本為已發布狀態,不支持編輯,系統將基于最新已發布的版本自動創建一個新版本并自動填充版本號,您確定版本及版本號無誤后,單擊確定進入新增API版本頁面。
API版本為已提交或草稿態時,可直接進入API編輯頁面。
測試
單擊操作列下的測試圖標,跳轉至開發 > API > API測試頁面,系統會自動進入當前API最新的可測試版本進行測試(版本為已提交或已發布狀態),您也可以在右上角切換版本進行測試。
在測試環境,支持多個API共存并進行測試,根據調用不同的API測試效果,將反饋效果好的發布到線上應用。操作詳情請參見步驟一:測試API。
版本管理
單擊操作列下的更多圖標,選擇版本管理,在版本管理面板中,您可以對不同版本的API執行編輯、調試、版本對比、刪除、克隆等操作。
說明若下游應用調用API的API_ID無法修改,在API的數據源或查詢條件發生變更后,可通過多版本的方式開發、測試后,再將新版本發布至生產環境中以覆蓋原來的版本,避免下游應用端的調整。配置詳情請參見API多版本管理。
修改API分組
單擊操作列下的更多圖標,選擇修改API分組,在修改API分組對話框中,選擇API分組后單擊確定。
轉交負責人
單擊操作列下的更多圖標,選擇轉交負責人,在轉交負責人對話框中,選擇個人賬號,支持將API轉讓至該項目下的其他開發用戶或項目管理員,單擊確定即可轉交負責人。
克隆API
單擊操作列下的更多圖標,選擇克隆API,在克隆API對話框中,選擇需要克隆的版本,單擊確定進入新建API頁面,可修改更多信息。
說明克隆API會克隆API所選版本的所有信息并創建為一個新的API。由于API名稱項目內唯一,請修改新建的API名稱,避免無法提交API。
系統默認選中最新提交(含發布)版本,克隆API支持克隆當前API所有狀態的版本。
刪除
單擊操作列下的更多圖標,選擇刪除,若該API不存在依賴,在API刪除對話框中,單擊確定即可刪除;若該API權限被應用授權或被組合API引用,回收該API被應用申請的權限或去除組合API對該API的引用后才能繼續刪除。
API多版本管理
新增API版本
在API列表頁面,單擊操作列表下的版本管理,進入版本管理面板。
在版本管理面板中,單擊新增版本,配置參數。
參數
描述
基于已有版本
默認填充最近版本,支持選擇當前API所有狀態的版本。
版本號
系統默認填充版本號,支持修改。每個API擁有唯一的版本號,以便于和上個版本信息對比。字符64個以內,該API下版本號唯一。
單擊確認,跳轉至新增API版本頁面,配置參數信息。
信息確認無誤后,單擊提交,完成新版本API的創建。您可在API列表頁面對該API進行管理。
管理API版本
區域 | 描述 |
①API名稱 | 為您展示當前API的名稱。 |
②列表區 | 為您展示版本號、版本狀態、創建人、更新時間信息。 |
③操作區 | 不同狀態的版本支持不同的操作。
操作詳情如下:
|