華為云計算 云知識 華為云CodeArts API實用體驗入門篇:API開發(fā)的必備神器
華為云CodeArts API實用體驗入門篇:API開發(fā)的必備神器

API開發(fā)的必備神器:華為云CodeArts API實用體驗入門篇

今天我想給大家推薦一款API全生命周期研發(fā)與管理工具:華為云CodeArts API。

作為互聯(lián)網(wǎng)軟件的開發(fā)者,在軟件研發(fā)的過程中,API的開發(fā)、調(diào)試、測試是必不可少的。之前我使用的是Postman這類工具來輔助開發(fā), Postman在接口調(diào)試方面確實有一定的優(yōu)勢。然而,隨著項目復雜度的提升和團隊協(xié)作需求的演變,我們開始尋求在API設計的標準化、接口編排測試、以及Mock服務的高效集成等方面更加全面且高效的解決方案。

直到同事向我推薦了華為云CodeArts API,我們親身體驗了華為產(chǎn)品,解決上述需求方面的出色表現(xiàn)讓我欣喜,所以我迫不及待地想將其分享給大家,希望能幫助更多的開發(fā)者解決開發(fā)中遇到的問題。

在試用CodeArts API以后,我遇到的第一個問題就是如何把Postman上的數(shù)據(jù) 遷移 到新工具上,當然可以將Collection一個一個的導出,并導入到新工具上,但是由于我之前的接口太多了,顯然一個個操作是一件很困難的事情。

CodeArts API特別強化了對Postman用戶遷移數(shù)據(jù)的支持,現(xiàn)在可直接導入Postman全量的Collections文件與Environments環(huán)境變量,這意味著數(shù)據(jù)遷移將會變得非常便捷。

首先從Postman的Settings -> Data頁面,將Collections和Environments 數(shù)據(jù)集 導出,此時可以得到一個ZIP的壓縮包,其中包含了多個Collection和Environment文件。

我們可以選擇將此壓縮文件導入到CodeArts API的API設計或快捷調(diào)試。

    選擇要導入的ZIP文件壓縮包,并可以選擇接口和環(huán)境變量。

導入成功后發(fā)現(xiàn),原來在Postman上同一個接口的快捷調(diào)試將會被合并,變成一個API下面的調(diào)試用例,API設計完全與我的項目一致,以后再需要調(diào)試,就可以直接使用API設計的調(diào)試能力了。

并且在Postman中,為API調(diào)試寫的腳本也都同步遷移過來了,而且可以繼續(xù)運行,CodeArts API的接口調(diào)試腳本完美兼容了Postman。

 

  • 可視化API設計與Swagger原生編輯

由于我之前使用的是Postman的離線版本,主要將Postman作為接口的調(diào)試工具,沒有使用過Postman做接口設計。這次在試用CodeArts API過程中,發(fā)現(xiàn)它在API設計上的精彩表現(xiàn),所以我也想嘗試下API設計。

CodeArts API與傳統(tǒng)的API設計工具有所區(qū)別,我們項目組都是將API編寫為Swagger的Yaml格式文件,并提交到代碼倉中,然后通過maven插件去生成接口與變量的java代碼。但是對于項目組的新員工并不是很友好,并且在排查接口文件內(nèi)容的時候,也經(jīng)常需要花費很多精力。

CodeArts API可以支持可視化的API設計,這對于菜鳥是非常友好的。

與此同時,如果是像我一樣有經(jīng)驗的開發(fā)者,也可以使用Swagger原生編輯器去設計API,并且CodeArts API提供了設計規(guī)范檢查功能,可以在Swagger編輯器中查看是否編寫錯誤。

并且CodeArts API支持將接口文檔以yaml的格式導出,直接將其復制到代碼中提交即可,這極大的提升了設計效率,所以以后我也會把CodeArts API作為我的軟件設計工具首選。

目前我也是剛剛開始使用華為云的CodeArts API工具,除了以上分享的功能外,CodeArts API還提供了API Mock和API測試等能力,深度使用以后,我會持續(xù)跟大家分享我的實用體驗。