DataWorks數據服務的主要目標是為個人、團隊和企業構建統一的數據服務總線，幫助用戶統一管理面向內外部的API服務。例如，您可以將查詢數據表功能快速的生成對應的API，或將已有的API注冊至數據服務平臺進行統一發布和管理。本文以MySQL數據源為例，為您介紹API開發的全套流程。
前提條件
背景信息
DataWorks數據服務作為數據庫和數據應用之間的橋梁，旨在為個人、團隊及企業提供全面的數據服務及共享能力，幫助用戶統一管理面向阿里云內外部的API服務。
數據服務已與API網關連通，支持一鍵發布API至API網關。數據服務與API網關為您提供安全、穩定、低成本、易上手的數據開放共享服務。更多數據服務的介紹，詳情請參見數據服務概述。
進入數據服務
登錄DataWorks控制臺，切換至目標地域后，單擊左側導航欄的，在下拉框中選擇對應工作空間后單擊進入數據服務。
操作流程
使用數據服務創建API前，需先將您的數據庫或數據倉庫添加為DataWorks數據源，以此作為數據服務API的數據來源。開發數據服務API時，數據服務將訪問該數據源獲取數據表的Schema信息，幫助您進一步設置請求和返回參數。調用數據服務API時，數據服務將訪問該數據源來執行查詢請求。
數據服務基于API網關對外提供服務。在API網關中，分組是API的管理單元，并與調用地址的域名相關聯。因此，在數據服務中創建API前，需先在API網關創建API分組。
數據服務基于業務流程實現以業務為單元的數據服務API開發，并通過業務流程對API及創建API所使用的函數等文件進行組織管理。因此，在數據服務創建API前，需先新建業務流程。
業務流程創建完成后，您可基于該業務流程創建相應業務的API。
已創建的API需進行測試運行，測試通過后，該API才可發布上線。
通過測試的API需發布上線，發布成功后，其他服務才可調用該API。
數據服務支持使用簡單身份認證及加密身份認證調用數據服務API，您可根據需要選擇。
發布上線的API可在服務管理頁面查看，同時，數據服務支持根據業務需求進行下線、授權及查看API調用詳情等管理操作。
步驟一：創建數據源并配置網絡連通性
使用數據服務創建API前，您需將數據庫或數據倉庫添加為DataWorks的數據源，并保障數據服務資源組與您的目標數據源網絡連通，以便調用API時DataWorks可成功訪問數據源。
在左側導航欄單擊數據源管理，進入數據源管理頁面。
創建數據源并測試網絡連通性。
單擊新增數據源，選擇所需數據源類型。
本文示例選擇MySQL。
配置數據源信息。
根據實際需要進行配置，詳情請參見配置MySQL數據源。
選擇數據服務資源組并測試資源組與數據源的連通性。
本文示例使用開通DataWorks時默認提供的公共數據服務資源組。
說明在任務高并發執行且無法錯峰運行的情況下，需要專有資源來保障高并發和高頻率的API調用。建議您選擇購買使用DataWorks的獨享數據服務資源組。詳情請參見新增和使用獨享數據服務資源組。
單擊完成，成功創建數據源。
本文示例新建名為
rds_workshop_log的MySQL數據源，并測試該數據源與公共數據服務資源組的連通性，參數配置如下圖。
步驟二：創建API分組
數據服務基于API網關對外提供服務。在API網關中，分組是API的管理單元，并與調用地址的域名相關聯。因此，在數據服務中創建API前，需先在API網關創建API分組。
進入API網關。
在左側導航欄單擊。
在分組管理界面，單擊創建分組，新建分組。
本文示例新建名為
Workshop的分組。
步驟三：新建業務流程
數據服務基于業務流程實現以業務為單元的API開發，并基于業務流程對API及創建API所使用的函數等文件進行組織管理。因此，創建API前，需先新建業務流程。
新建業務流程。
在頁面，通過如下兩種方式新建：
方式一：單擊
圖標，選擇新建業務流程。方式二：右鍵單擊左側導航欄的業務流程目錄，選擇新建業務流程。
配置業務流程相關參數。
配置
描述
業務名稱
根據業務場景自定義名稱。本文示例創建的業務流程名為DataService。
API分組
選擇API分組，用于后續管理API。本文示例使用步驟二中創建的Workshop分組。
說明API分組是針對某個功能或場景的API集合，也是API網關對API的最小管理單元。如果您需要新建分組，可參考步驟二：創建API分組操作。
單擊確定，成功創建業務流程。
業務流程創建完成后，您可在數據服務左側目錄查看目標業務流程詳情。
步驟四：生成API
您需根據業務需要，在創建的業務流程中生成API。
生成API。
在頁面，通過如下兩種方式生成：
方式一：單擊
圖標，選擇。方式二：右鍵單擊左側導航欄的目標業務流程，選擇。
定義API相關屬性。
在生成API對話框，配置API信息。本文示例配置如下圖。
主要參數介紹如下。配置項
描述
API模式
您可選擇使用向導模式或腳本模式創建API。
向導模式：無需具備編碼能力，即可快速配置一個數據API。
腳本模式：支持多表關聯、復雜查詢和聚合函數等高級功能，可自行編寫API的查詢SQL，滿足高階用戶的個性化查詢需求。
本文示例使用向導模式。兩種模式的更多介紹，詳情請參見生成API概述。
API名稱
自定義API名稱。本文示例創建的API名稱為
rpt_user_info_all_d。API Path
API的存放路徑，即相對于服務Host，API的請求路徑。該配置用于拼接API的調用地址。本文示例路徑配置為
/user。協議
支持HTTP及HTTPS。
如果您需要通過HTTPS協議調用API，請在發布API至網關后，在API網關控制臺綁定獨立域名并上傳SSL證書，詳情請參見支持 HTTPS。
請求方式
支持GET及POST。
說明當請求方式選擇GET時，后續API添加的請求參數的參數位置，僅支持選擇QUERY。
當請求方式選擇POST時，后續API添加的請求參數的參數位置，支持選擇QUERY和BODY。
返回類型
僅支持配置為JSON類型。
可見范圍
定義該API創建后的可見范圍，取值包括工作空間和私有。
工作空間：該API對本工作空間內的所有成員可見。
私有：該API僅對API的負責人可見，且暫不支持授權。
本文示例可見范圍選擇工作空間。
目標文件夾
定義API在左側業務流程中的存放目錄。若您還未創建業務流程，請參考步驟三：新建業務流程創建。
配置API參數。
在API的編輯頁面，配置API參數。本文示例配置如下圖。
選擇API的數據源。
在選擇表區域，選擇生成API所需的數據源表。
參數
描述
數據源類型
選擇需要基于哪類數據源創建API。本文示例選擇MySQL類型數據源。
數據源名稱
選擇需要基于該類型數據源下的哪個數據源生成API。本文示例選擇步驟一：創建數據源并配置網絡連通性創建的
rds_workshop_log數據源。數據源環境
標準模式工作空間支持選擇訪問開發或生產環境數據源，兩種環境的區別，詳情請參見必讀：簡單模式和標準模式的區別。本文示例選擇生產環境。
數據表名稱
選擇該數據源下需要生成API的數據表。本文示例選擇
rds_workshop_log數據源中的rpt_user_info_all_d表。定義請求參數和返回參數。
選擇數據表后，選擇參數區域會自動顯示該表的所有字段，您可根據需要選擇相應字段作為API的請求參數和返回參數。若需對字段進行排序，則可將目標字段添加至排序字段區域，進行相應調整。
本文示例請求參數為
uid，返回參數為該表的所有字段。說明單擊右側導航欄的請求參數或返回參數，即可修改參數中字段的類型、示例值、默認值等配置。具體請根據實際需要使用。
步驟五：測試API
API生成后，需單擊API編輯頁面右上方的測試，驗證API的請求與返回值是否符合預期。本文示例設置請求參數uid的值為0016359810821，測試返回結果。更多測試詳情，請參見測試API。
步驟六：發布API
API提交發布后才可在其他服務進行調用。單擊API編輯頁面右上方的提交，選擇對應版本進行發布。發布后的API，可在API網關查看。更多發布詳情，請參見發布API。
步驟七：調用API
調用API目前支持如下認證方式，您可根據需要選擇：
簡單身份認證：安全性低，適用于報表、數據大屏等場景。
加密簽名身份認證：安全性高，適用于應用開發場景。
單擊數據服務頂部菜單欄的服務管理，進入服務管理頁面。
在左側導航欄選擇API調用。
已發布的API將發布至API網關服務，您可通過API網關SDK調用API。詳情請參見客戶端調用API示例。
步驟八：查看與管理API
您可在服務管理頁面，查看已發布API，并執行相關管理操作。
區域 | 描述 |
在頁面，可查看當前已發布的API、已獲得授權及授權給他人的API。同時，可對擁有權限的API執行下線、授權、測試等操作。 | |
在頁面，可執行如下操作：
|