Dataphin數據服務系列之--API 配置、管理和消費

做者：張塵初 

研發小哥哥還在爲公司裏大量 API 只上不下，不可查不可用， 想找的 API 找不到而苦惱嗎？業務方小姐姐還在爲 API 開發時間長，業務相應不及時而抱怨吐槽嗎？ 鐺鐺鐺，Dataphin 數據服務 -- API 配置管理，閃亮登場！助力研發小哥哥五分鐘搞定 API，提高業務響應速度，同時大大提高 API 複用能力！

Dataphin 數據服務
Dataphin 是阿里巴巴數據中臺（OneData - OneModel、OneID、OneService）方法論的產品載體。Dataphin 數據服務是其中 OneService 部分的載體，是 Dataphin 產品的組成部分，是數據中臺的價值出口。鏈接數據和業務，主要解決數據最後一千米使用的問題。包括 API 管理、主題式即席查詢等能力。本次主要爲你們帶來數據服務中 API 配置、管理、和使用的相關產品功能介紹~

API 配置 - 五分鐘生成 API
配置生成主要有三大步驟：服務單元配置->API 配置->API 測試

服務單元配置
服務單元是數據服務產品中的概念，能夠理解爲一個邏輯表，能夠是下掛單個物理表或下掛多個物理表，也能夠是 Dataphin 邏輯表。配置人員根據須要選擇字段，並進行字段的相關信息（字段名稱和字段類型）配置。下圖是單物理表服務單元截圖。API 基於服務單元生成。服務單元跟 API 是一對多的關係。
目前數據源類型已支持：MySQL、ElasticSearch、AnalyticDB、HBase，8 月 30 即將支持 PostgreSQL、Oracle、MongoDB。更多數據源持續接入中。

API 配置
基於上文中配置好的服務單元，經過簡單的 SQL 腳本，配置 API 的請求參數和返回參數，選擇調用方法（支持 GET 和 LIST 兩種調用方法），選擇 API 更新頻率配置，便可快速生成 API。配置界面以下圖：

API 測試 
API 配置完成後，能夠快速進行測試，經過配置請求參數，能夠測試 API 的響應時間，以及返回內容詳情，等。以下圖：

API 管理 - 可上可下可維護

- API 上下線
在 API 管理界面，能夠清晰的看到 API 的使用狀況，被調用次數，發佈更新時間，等。同時能夠對新增 API 發佈上線，也能夠對已經存在的 API 下線和刪除。讓 API 的管理變得簡單。

- API 監控運維 
API 生成後，能夠進行 API 的監控和運維，包括 受權應用數、平均響應時長、調用次數、錯誤率、offline 百分比等指標的監控。 

API 消費 - 好找好拿
API 申請使用主要有三大步驟：API 服務市場查找->API申請和調試->API 使用
- API 服務市場查找
API 市場裏包含了企業內全部已經發布的 API 信息，支持按分組查看，支持按 API 名稱查找。能夠在 API 市場裏查看具體 API 的文檔詳情，也能夠直接申請使用 API。

- API 申請調試

在上文 API 市場中，找到須要的 API 後，點擊當即申請便可進入 API 的權限申請界面，入下圖。數據服務中 API 的權限管理依託 Dataphin 的公共權限體系能力，作到了 API 字段級別的權限申請管控。當 API 申請經過後，在我的的後臺，既能夠看到申請經過的 API。經過配置 API 的入參，能夠進行 API 調試，獲取當前 API 的返回值，查看是否符合預期。API 調試界面能夠對焦 API 測試界面，功能相同，多了 appkey 和 secret 傳參。

- API 使用
數據服務提供了統一的調用 SDK，系統工程師能夠在本身的系統中調用使用。

寫在最後
通過上述簡單的幾步操做後，以往須要花幾周的 API 在彈指一揮間就開發完成並在系統中成功使用上了~並且企業內的 API 管理變得輕鬆簡單~今後，API 好找、好配、好管理~

結語：
阿里巴巴數據中臺團隊，致力於輸出阿里雲數據智能的最佳實踐，助力每一個企業建設本身的數據中臺，進而共同實現新時代下的智能商業！

 

 

 

原文連接

本文爲雲棲社區原創內容，未經容許不得轉載。