注冊API是通過注冊的方式，將已有的服務注冊到服務平臺進行統一管理。本文為您介紹如何通過注冊方式生產API。
步驟一：選擇生成API的方式
在Dataphin首頁，選擇服務 > 開發。
在左上角選擇服務項目，然后單擊左側導航欄的API。在API頁面，單擊+新建API按鈕。
在API創建方式選擇對話框中，選擇注冊API，單擊確定。
步驟二：配置注冊API的參數信息
在新建API頁面配置參數。
參數
描述
API基礎信息配置
API名稱
API名稱命名規則如下：
只能包含漢字、字母、數字或下劃線（_）。
長度為4~42個字符。
以字母開頭。
全局唯一。
請求方式
API請求方式包括GET和LIST：
GET：請求服務器獲取指定的某個資源。
LIST：請求服務器獲取某一部分的資源。
API分組
選擇當前項目下配置的API分組，如需創建，請參見創建服務分組。
描述
填寫對API的簡單描述。128個字符以內。
協議
僅支持HTTP。HTTP即超文本傳輸協議HTTP（HyperText Transfer Protocol），是應用最為廣泛的網絡協議。
勾選HTTPS協議時，請確保獨立域名的SSL證書有效，避免無法正常調用。請通過選擇平臺管理網絡配置，在網絡配置頁面，進行SSL證書配置。
超時時間
超時時間用于監控API調用的時長。調用API過程中如果超過了設定的超時時間，則調用API時會報錯，便于您及時發現并處理調用API的異常情況。異常情況查看，詳情請參見查看及管理運維監控API。
版本號
請填寫API的版本號，每份配置信息會有所屬版本號，以便于和上個版本信息對比。64字符以內。該API下版本號唯一。
返回類型
默認JSON。
后端服務配置
模式
支持Basic或Dev_Prod兩種模式。
Basic模式下開發時、提交及發布線上均讀取生產庫。
Dev-Prod模式下開發及提交讀取開發庫，發布線上讀取生產庫。
請求方法
支持POST和GET，用于配置轉發調用后端服務的請求方法。
POST：若請求方法選擇POST，則請求參數支持選擇BODY。
GET：若請求方法選擇GET，則請求參數不支持選擇BODY。
API數據源
請選擇注冊API的數據源，如需創建，請參見創建API數據源。
服務path
后端服務的調用路徑。需以正斜線（/）開頭，128個字符以內。
例如：API數據源的URL地址為：http://88.100.19.58:*****/api/example，服務path為：/abc/djd，則后端服務的完整URL為：http://88.100.19.58:*****/api/example/abc/djd。
服務超時
用于監控轉發調用后端服務的時長。調用后端服務過程中如果超過了設定的服務超時時間，則調用API時會由于后端服務調用超時報錯，便于您及時發現并處理調用API的異常情況。異常情況查看，詳情請參見查看及管理運維監控API。
請求參數
參數名
對外開放的參數，即用戶訪問API時直接使用的參數。128字符以內。
參數位置
支持選擇Headers、Parameters、Body。
Headers：在解析請求參數時會添加到參數的頭部位置。
Parameters：在解析請求參數時會拼接數據源的URL。
Body：在解析請求參數時如果有多個參數，則會封裝成一個Body。
參數類型
當參數位置為Body時，支持選擇參數類型為Array(int)、Array(string)和Object。
當參數位置為其他時，參數類型包括DOUBLE、FLOAT、STRING、DATE(yyyy-MM-dd HH:mm:ss)、BOOLEAN、INT、LONG、SHORT、BIGDECIMAL，需選擇參數名對應的綁定字段的參數類型。
默認值
后端服務調用時，若無傳值，則以默認值傳入。
示例
填寫請求參數值的示例，便于開發者理解。
描述
填寫對請求參數的簡單描述。
是否必填
必填參數，若在調用API時不傳參數值，則API調用失敗。
返回參數
參數名
對外開放的參數，API返回時最終展示給用戶的參數名稱。128字符以內。
參數類型
返回參數類型包括DOUBLE、FLOAT、STRING、DATE(yyyy-MM-dd HH:mm:ss)、BOOLEAN、INT、LONG、SHORT、BIGDECIMAL、Array(int)、Array(string)11種，需選擇參數名對應的綁定字段的參數類型。
示例
填寫返回參數值的示例，便于開發者理解。
描述
填寫對返回參數的簡單描述。
返回參數取值路徑
僅支持JSON格式，當返回數據多層嵌套，需要配置對應的返回參數路徑。可點擊查看配置說明。
單擊提交，即可完成API的生成。