本(ben)文將為您介紹如何注(zhu)冊API，與通過(guo)數據表(biao)生成(cheng)的(de)API統一管理(li)和發布到API網關。
目前數據服務共享(xiang)版支持Restful風格的API注(zhu)冊，包含GET/POST常見請(qing)求(qiu)方式。
配置API基本信息
1.在DataArts Studio控制臺首頁，選(xuan)擇實例，點擊“進入(ru)(ru)控制臺”，選(xuan)擇對應工作(zuo)空(kong)間的“數(shu)據(ju)服(fu)(fu)務”模塊，進入(ru)(ru)數(shu)據(ju)服(fu)(fu)務頁面。
詳見下圖：選擇數(shu)據服務
2.在左側(ce)導航(hang)欄(lan)選擇服務(wu)共享版，進(jin)入(ru)總覽頁。
3.進入“數據服務(wu) > 開(kai)發API > API管理(li)”頁面，單擊(ji)“注冊(ce)現有API”，填寫API基(ji)本(ben)信息。
詳(xiang)見下表(biao)：API基本信息
| 配置 | 說明 |
|---|---|
| API名稱 | 支持中文、英文、數字、下劃線，且只能以英文或中文開頭，3-64個字符。 |
| API目錄 | 一個特定功能或場景的API集合，是數據服務中API的最小組織單元，也是API網關中的最小管理單元。 您可單擊“新建”進行新建，也可選擇新建API目錄已創建的API分組。 |
| 請求Path | 資源路徑，也即API訪問路徑。 示例：/v2/{project_id}/streams |
| 協議 | 用于傳輸請求的協議，支持HTTP和HTTPS協議。 |
| 請求方式 | HTTP請求方法（也稱為操作或動詞），它告訴服務你正在請求什么類型的操作。 GET：請求服務器返回指定資源。 POST：請求服務器新增資源或執行特殊操作，注冊API時推薦使用。POST請求當前不支持body體，而是直接透傳。 |
| 描述 | 對API進行簡要描述。 |
| 標簽 | 用戶自定義輸入，只能包含中文、英文字母、數字和下劃線，且不能以下劃線開頭。 |
| 審核人 | 擁有API的審核權限。 單擊“新建”，進入“審核中心>審核人管理”頁面，新建審核人。 |
| 安全認證 | API認證方式： APP認證：表示由API網關服務負責接口請求的安全認證。? IAM認證：表示借助IAM服務進行安全認證。 無認證：表示不需要認證。 |
| 服務目錄可見性 | 發布后，所選范圍內的用戶均可以在服務目錄中看到此API。 當前工作空間可見 當前項目可見 當前租戶可見 |
| 訪問日志 | 勾選，則此API的查詢結果將會產生記錄并被保留7天，可以在“運營管理>訪問日志”處通過選擇“請求日期”的方式查看對應日期的日志。 |
| 最低保留期限 | API解綁前預留的最低期限。API進行停用/下線/取消授權時,會通知已授權用戶,并為用戶預留至少X小時,直到所有授權用戶均完成解除或處理，或者到達截止時間, API才會停用/下線/取消授權。0表示不設限制。 |
| 入參定義 | 配置API請求中的參數，包含資源路徑中的動態參數，請求URI中的查詢參數和Header參數。 以配置資源路徑中的動態參數為例進行說明，例如資源路徑（請求Path）設置為： /v2/{project_id}/streams，資源路徑中的{project_id}為動態參數，需要在此進行配置。 1. 單擊“添加”，參數名配置為project_id。 2. 參數位置選擇PATH。 3. 類型設置為STRING。 4. 選擇性配置示例值和描述。 |
4.配(pei)置好API基本信息后(hou)，單擊“下一步(bu)”，即可進入API取數邏輯(ji)頁面。
配置API參數
配(pei)置(zhi)API基本信息后(hou)，即可配(pei)置(zhi)API參(can)數。這里(li)將配(pei)置(zhi)API的后(hou)端服務和請求參(can)數。
詳見(jian)下表： API參(can)數配置說(shuo)明
| 配置 | 說明 |
|---|---|
| 協議 | 用于傳輸請求的協議，支持HTTP和HTTPS協議。 用于數據服務模塊向待注冊API服務傳輸請求。 |
| 請求方式 | HTTP請求方法（也稱為操作或動詞），它告訴服務你正在請求什么類型的操作。用于數據服務模塊向待注冊API服務傳輸請求。 GET：請求服務器返回指定資源。 POST：請求服務器新增資源或執行特殊操作。 |
| 后端服務HOST | 待注冊API服務的Host，不能以//或//開頭，并且不包含Path。 |
| 后端服務PATH | 待注冊API服務的Path，Path中支持參數，參數要放在{}中，如/user/{userid}。 |
| 后端超時（ms） | 設置后端超時時間。 |
| 后端服務參數 | 請求參數位置支持Path、Header、Query，不同的請求方式所支持的可選參數位置不一樣，請根據產品上提供的可選項按需選擇。 |
| 常量參數 | 常量參數即參數值是固定的參數，對調用者不可見，API調用時不需傳入常量參數，但后臺服務始終接收這里定義好的常量參數及參數值。適用于當您希望把API的某個參數的取值固定為某個值以及要對調用者隱藏參數的場景。 |
API測試
完成API參數(shu)的(de)配置并保(bao)存后，單(dan)擊左下角的(de)“開始(shi)測(ce)試(shi)”，即可進入API測(ce)試(shi)環節。 填寫(xie)參數(shu)值，單(dan)擊“開始(shi)測(ce)試(shi)”，即可在線發送API請(qing)求(qiu)，在右側可以看到(dao)API請(qing)求(qiu)詳(xiang)情及返回內(nei)容。如果測(ce)試(shi)失敗(bai)，請(qing)仔細(xi)查看錯(cuo)誤提(ti)示并做相應的(de)修(xiu)改重新測(ce)試(shi)。配置過程(cheng)中需要注意(yi)正常返回示例(li)的(de)設置。
完成API測試之(zhi)后，單(dan)擊“確定(ding)”，即完成注冊數(shu)據(ju)API。
