DataWorks：註冊外部API服務

註冊API

如果您沒有API，則需要使用產生API功能。詳情請參見通過嚮導模式產生API。

1. 在服務開發頁面，單擊表徵圖，選擇建立API > 註冊API。

   您也可以開啟相應的商務程序，按右鍵API，選擇建立API > 註冊API。

2. 在註冊API對話方塊中，配置各項參數後，完成配置。

   

   參數	描述
   目標檔案夾	存放API的目錄，請單擊文字進行選擇。 重要 建議優先選定目標檔案夾，若選不中，請先建立商務程序。
   API名稱	自訂API名稱。網關分組下唯一且工作空間下唯一。
   API Path	API存放的路徑，例如/user。
   協議	支援HTTP、HTTPS協議。 如果您需要通過HTTPS協議調用API，請您發布API至網關後，在API Gateway控制台綁定獨立網域名稱，並上傳SSL認證。詳情請參見支援HTTPS。
   請求方式	支援GET、POST、PUT和DELETE。
   傳回型別	支援JSON和XML。
   可見範圍	包括工作空間和私人： 工作空間：該API對本工作空間內的所有成員可見。 私人：該API僅對API的負責人可見，且暫不支援授權。 說明 如果設定可見範圍為私人，在分類樹中，僅自己可見，工作空間內的其他成員不可見。
   標籤	從標籤列表中選擇相應的標籤。
   描述	對API進行簡要描述，不得超過2000個字元。

配置API

1. 雙擊開啟註冊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。具體的可根據您介面服務地址實際路徑進行配置。
   後端逾時	設定後端逾時時間。

2. 在請求參數定義地區，配置各項參數。

   

   參數	描述
   請求參數	單擊新增參數，根據頁面配置API的請求參數。 其中參數位置支援QUERY、HEAD、PATH和BODY。不同的請求方式支援不同的參數位置，請根據頁面提供的可選項按需選擇。
   常量參數	參數值為固定的參數，對調用者不可見。調用API時無需傳入常量參數，但後台服務始終接收您在此處配置的常量參數及參數值。 適用於固定某個參數的取值並對調用者隱藏參數的情境。
   請求Body定義	僅請求方式為POST和PUT時，會出現該參數。 請求Body定義支援輸入JSON和XML類型的Body描述，相當於一個請求Body的樣本，以供API調用者參考格式。

3. 在返回內容定義地區，輸入正常返回結果樣本和異常返回結果樣本，以便API調用者參考和編寫API返回結果解析代碼。

4. 在錯誤碼定義地區，填寫調用API時出現的錯誤碼、錯誤資訊和解決方案，以便API調用者參考並自行尋找錯誤原因。

5. 單擊上方工具列中的表徵圖，儲存API。