如何基於 eoLinker 的進行API接口管理

時間 2019-12-05

標籤如何基於 eolinker 進行 api 接口管理简体版

原文原文鏈接

因爲工做的緣由，常常要接觸到不少API接口，而API接口在設計時每每須要編寫大量的文檔，並且編寫完成後每每須要根據實際狀況，常常改動文檔，這使得文檔編寫維護工做量相對較大，這讓我也包括不少的開發者都很頭疼。git

此外，伴隨着接口版本的迭代開發，接口文檔也須要同步更新。並且接口開發完成之後，作接口測試會十分不方便，要是趕上接口數量多、參數負載的狀況，那不只不方便，測試工做量會重上加劇。程序員

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

上述的問題其實讓我在工做中很苦惱，後來通過前輩推薦一個開源並且免費的eoLinker，剛使用時的時候以爲界面很不錯，發現這個工具的開源版是基於PHP框架的，我目前使用的開源版本也能把個人數據保存在我本身的服務器上，保證了個人數據安全，使用了一段時間後，用起來的確還能解決一些其餘問題，例如自動化測試、根據註釋生成文檔之類的。感興趣的能夠去了解一下，在此我分享一些使用過程當中的心得。安全

【接口信息清晰完善】服務器

沒有文檔的庫，就比如一個黑盒，咱們沒法預期它的正常行爲。輸入了一個 A，預期返回的是一個 B，結果它什麼也沒有。有的時候，還拋出了一堆異常，致使你的應用崩潰。而接口信息模糊冗雜，不但加大了我理解的難度，還增長了無謂的溝通成本，拖延項目進度。爲此，咱們在編寫接口時，我通常都會考慮完善，接口錄入信息清晰有條理，避免含糊不清的用詞和參數，後續也能查看和修改。框架

【接口文檔更新及時】工具

由於隨着接口版本的迭代開發，接口信息有所變化，舊文檔已經不能知足接口的要求，我能夠經過對相應接口文檔的接口操做，根據現有接口信息進行從新錄入，快速保存爲接口的新文檔。更新及時的功能算是我最喜歡的功能了。測試

【接口操做歷史可溯源】設計

相似gitHub，接口文檔的每一次改動歷史應清晰記錄下來。在後期接口管理和維護上，我只要經過對操做歷史的查看，就能夠了解到每次改動的目的和內容，進而更加方便管理接口。目前發現能夠記錄了接口文檔近十次的操做歷史，也支持接口歷史一鍵回溯功能，算是必定程度上下降了成員對接口文檔誤操做的風險。 cdn

【成員權限有所限制】

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

【接口測試同步完成】

編寫完接口文檔後，爲驗證接口返回值是否符合接口文檔所描述的預期結果，我是須要對接口進行測試。eolinker也提供接口本地一鍵化測試功能，只要將信息錄入eolinker接口管理平臺，就沒必要將接口信息從新複製到測試工具的操做，這讓我以爲很方便。我只須要點擊測試頁面，輸入測試參數值，即可完成測試。也提供mock測試功能，經過設置假數據以驗證接口的可行性。還提供自動化測試，應對不一樣測試場景。