哇,今天才發現eoLinker這個接口管理神器!

API接口在設計時每每須要編寫大量的文檔,並且編寫完成後每每須要根據實際狀況,常常改動文檔,文檔編寫維護工做量相對較大,有點頭疼。git

因爲咱們項目還常常會由於交付週期的緣由,須要接入一個第三方的庫,而第三方的庫一般都存在文檔老舊,文檔不夠全面等等或多或少的問題。那這個問題相比於沒有文檔,對程序員來講更加難以棘手。由於會形成:咱們須要的接口不在文檔上,文檔上的接口不存在庫裏,又或者是少了一行關鍵的代碼。 程序員

而後我在網上找解決辦法,找到了eoLinker,做爲苦逼的開發,在此分享我一些使用過程當中的心得,但願都能脫(ji)離(xu)苦(kai)海(fa)。

接口信息清晰了

沒有文檔的庫,就比如一個黑盒,咱們沒法預期它的正常行爲。輸入了一個 A,預期返回的是一個 B,結果它什麼也沒有。有的時候,還拋出了一堆異常,致使你的應用崩潰。

而接口信息模糊冗雜,不但加大了開發人員理解的難度,還增長了無謂的溝通成本,拖延項目進度。 爲此,咱們在編寫接口時,應考慮完善,接口錄入信息清晰有條理,避免含糊不清的用詞和參數。

接口更新及時

隨着接口版本的迭代開發,接口信息有所變化,舊文檔已經不能知足接口的要求,開發者能夠經過對相應接口文檔的接口操做,根據現有接口信息進行從新錄入,快速保存爲接口的新文檔。

接口操做歷史可溯源

相似gitHub,接口文檔的每一次改動歷史應清晰記錄下來。在後期接口管理和維護上,經過對操做歷史的查看,開發者能夠了解到每次改動的目的和內容,進而科學管理接口。

eolinker AMS記錄了接口文檔近十次的操做歷史,支持接口歷史一鍵回溯功能,下降了成員對接口文檔誤操做的風險。

成員權限有所限制

在項目開發中,因爲每一個團隊成員在項目中擔任的角色不一樣,他們對接口文檔應有不一樣的操做權限,以確保相關接口文檔的完整性和安全性。 eolinker AMS提供了靈活的權限管理,經過分配適當權限給相應成員,保證開發時文檔不被無關人員篡改。

接口測試同步完成

編寫完接口文檔後,爲驗證接口返回值是否符合接口文檔所描述的預期結果,開發者們須要對接口進行測試。

eolinker AMS提供接口本地一鍵化測試功能,只要將信息錄入eolinker接口管理平臺,你將會省去將接口信息從新複製到測試工具的操做。你只須要點擊測試頁面,輸入測試參數值,即可完成測試。

還提供mock測試功能,經過設置假數據以驗證接口的可行性。

以上!
相關文章
相關標籤/搜索