本文為您介紹如何查看、刪除、移動、克隆、批量操作和代碼搜索API。
查看API
登錄DataWorks控制臺,切換至目標地域后,單擊左側導航欄的 ,在下拉框中選擇對應工作空間后單擊進入數據服務。
在服務開發頁面,展開目標API所在的 。
右鍵單擊相應的API名稱,選擇詳情。
說明僅已發布的API支持通過右鍵單擊詳情查看。如果API未發布,您可以單擊該API編輯頁面右側的屬性,查看其基本信息。
克隆API
您可以為API創建副本,存放至目錄樹的指定路徑下:
在服務開發頁面,展開目標API所在的 。
右鍵單擊相應的API名稱,選擇克隆。
在API克隆對話框中,配置各項參數。
參數
描述
API名稱
支持漢字、英文、數字和下劃線,僅支持以英文或漢字開頭,且名稱的長度支持4~50個字符。
API Path
API存放的路徑,例如/user。
API Path支持英文、數字、下劃線和連字符(-),僅支持以斜線(/)開頭,且不能超過200個字符。
描述
對克隆出的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
DataWorks支持對API進行批量修改數據服務資源組、提交、發布操作。從而實現API快速切換資源組并重新上線。
進入數據服務頁面,在服務開發的左側目錄樹頂部,單擊按鈕,進入批量操作頁面。
在批量操作頁面上部,通過業務流程、負責人等條件進行過濾。
在過濾后的列表中,勾選待批量處理的API。
選擇完成后,您可以在底部選擇對已選的多個API進行批量操作。
批量操作和API狀態之間的關系如下:
批量操作
未發布&未提交
未發布&已提交
已發布&未提交
已發布&已提交
修改服務資源組
提交
不能重復提交,需要進入API編輯頁面,在右側的版本管理里,廢棄前一次提交的版本。
不能重復提交,需要進入API編輯頁面,在右側的版本管理里,廢棄前一次提交的版本
發布
發布的前置條件是已提交,因此對于未提交API,需要先執行提交,再操作發布
發布的前置條件是已提交,因此對于未提交API,需要先執行提交,再操作發布
說明對已發布的API修改服務資源組后,需要重新測試、提交、發布后才會在實際調用中生效。
通過代碼搜索API
支持您在當前工作空間內對腳本模式創建的API的進行代碼搜索。
單擊左側菜單欄的按鈕,進入代碼搜索頁面。
單擊搜索框右側的按鈕可以展開過濾條件。
支持您在搜索框輸入API名稱、API Path、API描述或數據表名、字段名等關鍵字搜索API,還支持您按照負責人、業務流程、修改時間等過濾條件對查詢結果進行篩選。
查看搜索結果。
搜索下方將為您展示匹配搜索條件的結果,包括:
說明僅展示已發布的API。
API名稱:單擊API名稱后,將會在右側打開對應API的窗口。
代碼內容:展示匹配到的代碼關鍵字、所屬行以及簡要上下文,支持您復制匹配到的代碼內容。
基礎信息:展示API ID、負責人、業務流程、最近修改時間等信息。