Dataphin：測試與發布API

前提條件

在開始執行操作前，請確認您已完成API的建立。更多資訊，請參見建立API。

API調用/測試直連模式和代理模式說明

資料服務支援直連模式和代理模式調用API，若API關聯了行級許可權，則根據調用模式確認鑒權方式。

• 直連模式：在行級許可權中申請資料服務應用的行級許可權，使用應用進行鑒權。

• 代理模式：若應用需代理使用者的行級許可權調用API，需在行級許可權中申請資料服務應用的行級許可權，再為應用申請API的代理許可權，即可代理使用者調用API。

API測試頁面頂部地區操作

• 查看網域名稱：在頁面頂部可以查看網域名稱，該網域名稱僅用於自我裝載，用於用戶端調用的網域名稱，請參見查看網域名稱。

• 切換API：支援在頁面左上方切換查看已提交或發行的API。支援根據API的名稱或ID模糊搜尋API，搜尋當前服務專案下有許可權的API進行切換，系統將為您推薦您在當前專案下訪問過（包括查看、編輯、測試、新增）的最近9條API。

• 切換API運行環境：支援切換API運行環境進行API測試。當運行環境為開發環境時，使用開發資料來源進行測試；當運行環境為生產環境時，使用生產資料來源進行測試。如果API未發布，則無法切換為生產環境進行測試。

  說明

  若API為Basic模式，且運行環境為開發環境時，測試API時會使用生產資料來源進行測試。

• 切換API版本：支援在測試頁面的右上方切換版本進行測試。當運行環境為開發環境，支援選擇已提交的版本；當運行環境為生產環境，支援選擇發行的版本。

步驟一：測試API

1. 在Dataphin首頁的頂部功能表列，選擇服務 > API開發。

2. 在左上方選擇服務專案，在左側導覽列選擇API服務 > API，進入API頁面。

   • 在API頁面單擊目標API操作列下的測試表徵圖，進入API測試頁面。

   • 在API頁面單擊目標API操作列下的更多-版本管理，進入版本管理面板，再單擊目標API操作列下的測試，進入API測試頁面。

3. 在API測試頁面，您可以輸入參數值來驗證返回參數是否符合預期。

   1. 配置業務請求參數列表地區的參數。

      • 當操作類型為GET、LIST時，測試輸入值為業務資料中的欄位值，列表參數是您建立API時配置的請求參數。

      • 當操作類型為Create、Update、Delete時，列表欄位是您建立API時配置的請求參數，您可以進行如下操作進行添加、複製或刪除參數。

        • 添加參數項：單擊添加參數項按鈕，根據欄位後的提示輸入參數值，支援添加不超過API最大輸入條數的資料。

        • 大量新增：單擊大量新增，在大量新增業務請求參數對話方塊中，輸入參數執行個體值，每組參數按行分隔，支援為參數添加分隔字元和文本限定符。

          • 分隔字元：用於分隔欄位的字元，多個參數之間支援使用半形逗號（,）、半形分號（;）、豎線（|）、定位字元（\t）、其他（自訂輸入，可輸入多個字元）分隔。

          • 文本限定符：用於定義文字欄位的字元，支援無、雙引號（""）、單引號（''）。

        • 全屏輸入：單擊全屏輸入，再單擊底部添加1行參數項、添加5行參數項、添加10行參數項快捷添加行數。

        • 複製：單擊操作列下的複製表徵圖，系統將複製當前行參數值並在末尾新增一行填充。

        • 刪除：單擊操作列下的刪除表徵圖或選中列表參數，單擊底部大量刪除按鈕，整行刪除參數。

   2. 配置公用請求參數列表地區的參數。

      • 當API類型為直連資料來源API（查詢類型）或服務單元API時，系統根據API不同的請求方式，展示不同的參數（PageStart、PageSize和OrderByList）。

        • 開啟分頁查詢，若API操作類型為LIST，展示PageStart、PageSize和OrderByList參數；若API操作類型為GET，展示OrderByList參數。

        • 關閉分頁查詢，若API操作類型為LIST，展示OrderByList參數，您可以取消選中隱藏參數，展示PageSize和OrderByList參數。

      • 當API類型為直連資料來源API（查詢類型）、服務單元API或組合API且關聯線級許可權開啟時，展示AccountType、DelegationUid參數。

      • 當API類型為直連資料來源API（操作類型）時，僅展示ApiVersion參數。

        說明

        測試API時，輸入參數字元長度不超過1000個；若直接調用API，則無字元長度限制。

        參數	描述	調試輸入值
        AccountType	當使用代理模式認證時，需要指定代理使用者的帳號類型。 ACCOUNT_NAME：Dataphin的使用者名稱。 USER_ID: Dataphin內部的唯一ID。 SOURCE_USER_ID：源系統帳號ID。 說明 僅當設定了DelegationUid時，需要配置此參數。若未填寫此參數，則預設類型為USER_ID。	選擇指定代理使用者的帳號類型，支援選擇ACCOUNT_NAME、USER_ID、SOURCE_USER_ID。
        DelegationUid	被代理訪問的使用者，需根據所選AccountType的類型，傳入對應帳號ID。設定該參數後，使用代理模式的認證方式。	僅支援當前租戶帳號作為DelegationUid。
        ApiVersion	用於指定調用API的版本，預設使用最新版本。	調試輸入值從頁面右上方切換版本擷取。 說明 當運行環境為開發環境，支援apiVersion參數，僅可選擇已提交的API進行調用。
        PageStart	用於定義返回資料從第幾條開始展示。	配置成正整數，例如2。
        PageSize	用於定義每頁返回多少資料。	配置成正整數，例如56。
        OrderByList	用於定義多個返回參數的排序方式。如果沒有填寫，則預設為升序排列。	調試輸入值需要從業務請求參數列表中擷取。
        ReturnTotalNum	用於定義是否返回結果總行數，當ReturnTotalNum=true時，返回結果總行數，但對效能有一定損耗。	當API操作類型為List且開啟分頁查詢時展示此參數。 配置成正整數，例如1000。

   3. 當API類型為直連資料來源API（查詢類型）、服務單元API或組合API且關聯線級許可權開啟時，在行級許可權列表地區展示當前API版本及環境對應的所關聯的已開啟的行級許可權資訊，包括行級許可權名稱、描述說明。

   4. 在可選返回參數列表地區選取項目返回參數。返回參數的列表為已選擇的API版本對應的API返回參數。

      • 當操作類型為GET、LIST時，您需要選擇至少一個返回參數才能測試API。

      • 當操作類型為Create、Update、Delete時，系統預設全部勾選，不可取消。

   5. 配置API的協議和返回條數。

      參數	描述
      協議	如果您建立API時選擇協議是HTTP和HTTPS，則調試API時可以選擇協議。
      返回條數	用於定義測試API時返回資料的條數： 如果請求方式為LIST，則支援選擇返回條數，最大可返回10000條資料。 請求方式為GET，不支援修改返回條數。

4. 配置完成後，單擊返回條數後的調試/測試，進行API與資料來源資料的連通性測試。

   • API測試時，支援單擊查看指令碼，查看SQL的指令碼，方便對比查詢結果是否符合指令碼處理預期。

     說明

     • 若註冊API、模型API無SQL指令碼，則無法查看。

     • 調用組合API時，若組合API引用的API有行級許可權管控，需將AccountType和DelegationUid參數傳入到引用的API。

     • 使用代理模式調用組合API，僅需申請組合API的代理許可權即可。

   • 若API調用模式為非同步模式，API測試/調試後，查詢結果將在測試結果地區展示，您可以在測試結果中查看您的運行結果、日誌、代碼等資訊，非同步查詢的流程請參見非同步呼叫流程說明。

     • 查看請求結果：單擊調用API頁簽，再單擊返回結果頁簽，可查看調用API的Body返回的請求結果。

     • 指令碼代碼：單擊調用API頁簽，再單擊指令碼代碼頁簽，可查看編寫的SQL語句。

     • 查看日誌：單擊擷取查詢狀態頁簽，查看API調用時的執行日誌。如需取消API測試/調試，可單擊取消查詢，取消查詢請求。

     • 查看查詢結果：單擊擷取查詢結果頁簽，可查看調用API的Body返回的最終查詢結果。

5. 在返回結果/測試結果地區，查看測試結果。

   如果測試失敗，您可以查看附錄：錯誤碼及解決方案。

6. 僅測試API時支援操作。單擊底部的API授權按鈕，支援將API授權給應用，詳情請參見資料服務許可權管理。

步驟二：發布API

後續業務應用使用者可以在資料服務總覽頁面查詢並申請調用API的許可權。

附錄：錯誤碼及解決方案