您可以將已有的API服務註冊到DataWorks資料服務中,以實現統一的發布和管理(例如查看API的調用資訊、調用日誌,管理API標籤、版本等),本文為您介紹如何註冊API。
註冊API
如果您沒有API,則需要使用產生API功能。詳情請參見通過嚮導模式產生API。
在服務開發頁面,滑鼠移至上方至表徵圖,單擊註冊API。
您也可以開啟相應的商務程序,按右鍵API,選擇
。在註冊API對話方塊中,配置各項參數。
參數
描述
API名稱
支援中文、英文、數字、底線(_),且只能以英文或中文開頭,4~50個字元。
API Path
API存放的路徑,例如/user。
說明支援英文、數字、底線(_)和連字號(-),且只能以( /) 開頭,不得超過200個字元。
協議
支援HTTP、HTTPS協議。
如果您需要通過HTTPS協議調用API,請您發布API至網關後,在API Gateway控制台綁定獨立網域名稱,並上傳SSL認證。詳情請參見支援HTTPS。
請求方式
支援GET、POST、PUT和DELETE。
傳回型別
支援JSON和XML。
可見範圍
包括工作空間和私人:
工作空間:該API對本工作空間內的所有成員可見。
私人:該API僅對API的負責人可見,且暫不支援授權。
說明如果設定可見範圍為私人,在分類樹中,僅自己可見,工作空間內的其他成員不可見。
標籤
從標籤列表中選擇相應的標籤。
說明標籤名稱支援漢字、英文、數字和底線(_),您最多可以設定5個標籤,且每個標籤不超過20個字元。
描述
對API進行簡要描述,不得超過2000個字元。
目標檔案夾
存放API的目錄。
單擊確認。
配置API
雙擊開啟註冊API的編輯頁面,在後端服務定義地區,配置各項參數。
參數
描述
後台服務Host
待註冊API服務的Host,以http://或https://開頭,並且不包含Path。
說明樣本:假設您介面服務地址為
http://xxx-cn-xxx.alicloudapi.com/user/info
,可取http://xxx-cn-xxx.alicloudapi.com
設為後台服務Host。具體的可根據您介面服務地址實際路徑進行配置。後台服務Path
待註冊API服務的Path,Path中支援參數,參數要放在[]中,如/user/[userid]。
配置Path中的參數後,在註冊API嚮導的第二步API參數配置環節,系統會自動在請求參數列表添加Path位置的參數。
說明樣本:假設您介面服務地址為
http://xxx-cn-xxx.alicloudapi.com/user/info
,可將/user/info
設為後台服務Path。具體的可根據您介面服務地址實際路徑進行配置。後端逾時
設定後端逾時時間。
在請求參數定義地區,配置各項參數。
參數
描述
請求參數
您可以單擊新增參數,根據頁面配置API的請求參數。
其中參數位置支援QUERY、HEAD和BODY。不同的請求方式支援不同的參數位置,請根據頁面提供的可選項按需選擇。
常量參數
參數值為固定的參數,對調用者不可見。調用API時無需傳入常量參數,但後台服務始終接收您在此處配置的常量參數及參數值。
適用於固定某個參數的取值並對調用者隱藏參數的情境。
請求Body定義
僅請求方式為POST和PUT時,會出現該參數。
請求Body定義支援輸入JSON和XML類型的Body描述,相當於一個請求Body的樣本,以供API調用者參考格式。
在返回內容定義地區,輸入正常返回結果樣本和異常返回結果樣本,以便API調用者參考和編寫API返回結果解析代碼。
在錯誤碼定義地區,填寫調用API時出現的錯誤碼、錯誤資訊和解決方案,以便API調用者參考並自行尋找錯誤原因。
單擊工具列中的表徵圖。
配置API後,您可以對其進行測試。詳情請參見測試API。
測試成功後,單擊右上方的提交。
在API編輯頁面的右側導覽列中,單擊版本,找到待申請版本單擊申請發布跳轉到申請頁面,申請類型預設為發布資料服務API,填寫申請原因後單擊申請許可權完成發布申請。
說明工作空間定義審批流後需要走流程審批才發行就緒API,詳情請參見:核准中心概述。
發布API後,服務資源群組的配置即可在調用API時生效。
您還可以在服務開發頁面左側分類樹中對目標API進行複製和刪除等操作。您也可以在服務管理頁面,展開API列表,查看發行API的詳情。詳情請參見查看、刪除、移動、複製、大量操作、程式碼搜尋API。