全部產品

Dataphin：管理API

更新時間：Nov 19, 2025

API建立完成後，您可以對API進行版本管理、轉交負責人等操作。本文為您介紹如何管理API。

許可權說明

超級管理員支援管理所有API。
專案系統管理員支援管理所負責專案下的API。
API負責人支援管理自己所負責的API。

API列表入口

在Dataphin首頁的頂部功能表列，選擇服務 > API開發。
在左上方選擇服務專案，再在左側導覽列選擇API服務 > API，在API列表頁面。
您可根據API的名稱或ID搜尋目標API，也可以快捷篩選今天提交的API、我的API，或者根據操作類型、API類型、資料來源、API分組、最近提交時間、模式、調用模式、目前狀態、負責人篩選目標API。
我的API：即我負責的API，不包括我申請了使用許可權的API。
API列表為您展示已建立的API，包括API的名稱及ID、API類型、資料來源、調用模式、模式（即環境）、操作類型、目前狀態、運行環境、發布版本、發布資訊、資料更新頻率、API分組、負責人、API相關 App的數量、許可權資訊、資料量等API詳情。

您可以在目標API的巨集指令清單執行如下操作。

操作項	描述
發布	單擊操作列下的發布或選中需發布的API，單擊底部的批量發布，在API發布對話方塊中，選擇需要發布的已提交版本，將API發布至生產環境中，詳情參見步驟二：發布API。說明若線上已有發布的版本，則API發布新版本到線上的過程中會對參數進行校正，包括新增必填請求參數、刪減請求參數、刪減返回參數、變更請求參數的資料類型以及變更調用類型。新版本發布到線上會影響API的調用，您可以在專案中設定不同的發布管控機制，在API發布時會根據其所屬專案的配置進行阻塞或發布，詳情請參見建立服務專案。基於邏輯表建立的API不支援批量發布。批量發布時，若未選擇版本，則該API不進行發布。
編輯	單擊操作列下的編輯表徵圖，進入編輯API頁面。說明系統預設進入API最新版本的編輯頁面，若需修改API的其他版本，您可以在編輯頁面的右上方切換API版本對不同版本進行編輯。當API版本為已提交或草稿態時，支援在頁面的左上方切換查看API。支援根據API的名稱或ID模糊搜尋API，搜尋當前服務專案下有許可權的API進行切換，系統將為您推薦您在當前專案下訪問過（包括查看、編輯、測試、新增）的最近9條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列表頁面，單擊巨集指令清單下的版本管理，進入版本管理面板。

在版本管理面板中，單擊新增版本，配置參數。

參數	描述
基於已有版本	預設填充最近版本，支援選擇當前API所有狀態的版本。
版本號碼	系統預設填充版本號碼，支援修改。每個API擁有唯一的版本號碼，以便於和上個版本資訊對比。字元限制為64個以內，該API下版本號碼唯一。

單擊確認，跳轉至新增API版本頁面，配置參數資訊。
資訊確認無誤後，單擊提交，完成新版本API的建立。您可在API列表頁面對該API進行管理。

管理API版本

地區	描述
①API名稱	為您展示當前API的名稱。
②列表區	為您展示版本號碼、版本狀態、建立人、更新時間資訊。
③操作區	不同狀態的版本支援不同的操作。草稿態：支援查看詳情、編輯、複製API、刪除。發行態（即線上正在使用版本）：支援查看詳情、測試、版本對比、複製API。發行態（即歷史發布版本）：支援查看詳情、測試、版本對比、複製API、刪除。已提交態：支援查看詳情、測試、編輯、版本對比、複製API、刪除。操作詳情如下：查看詳情：單擊操作列下的查看，查看API的配置詳情。您可以在頁面右上方切換版本查看API的配置詳情。您可以在頁面左上方切換查看API。支援根據API的名稱或ID模糊搜尋API，支援搜尋當前服務專案下有許可權的API進行切換，系統將為您推薦您在當前專案下訪問過（包括查看、編輯、測試、新增）的最近9條API。您可以單擊底部的編輯API、測試API按鈕，快捷編輯或測試API，當API為草稿態時不支援測試API操作。當API類型為直連資料來源API（查詢類型）且開啟行級許可權時，展示行級許可權資訊，您可切換查看對應環境及版本下該API所關聯的行級許可權資訊。測試：單擊操作列下的測試，跳轉至開發 > API > API測試頁面，預設進入目前的版本的API測試頁面，系統會自動進入當前API最新的可測試版本進行測試（版本為已提交或發行狀態）。您可以在頁面右上方切換版本進行測試。支援在頁面左上方切換查看已提交或發行的API。支援根據API的名稱或ID模糊搜尋API，搜尋當前服務專案下有許可權的API進行切換，系統將為您推薦您在當前專案下訪問過（包括查看、編輯、測試、新增）的最近9條API。在測試環境，支援多個API共存並進行測試，根據調用不同的API測試效果，將反饋效果好的發布到線上應用。操作詳情請參見步驟一：測試API。版本對比：單擊操作列下的版本對比，支援切換查看兩個版本之間的資訊差異。說明僅支援已提交和發行的版本進行對比；當僅有一個已提交或發行版本時，不支援版本對比；草稿態的版本不支援進行對比。直連資料來源API、SQL模式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進行切換，系統將為您推薦您在當前專案下訪問過（包括查看、編輯、測試、新增）的最近9條API。若該API的最新版本為發行狀態，不支援編輯，系統將基於最新發行的版本自動建立一個新版本並自動填滿版本號碼，您確定版本及版本號碼無誤後，單擊確定進入新增API版本頁面。 API版本為已提交或草稿態時，可直接進入API編輯頁面。刪除：單擊操作列下的更多-刪除，若該API不存在依賴，在API刪除對話方塊中，單擊確定即可刪除；若該API許可權被應用授權或被組合API引用，回收該API被應用申請的許可權或去除組合API對該API的引用後才能繼續刪除。