使用MockAPI加速項目開發

企業應該採起文檔優先的方法來開發API。雖然測試驅動的開發強調編寫設計良好的代碼,但文檔驅動的開發考慮了API的可用性。api

由文檔驅動的API開發使開發團隊在實際編寫一行代碼以前就能夠考慮從驗收標準到UI和用戶體驗的全部內容,可是,它可能會減慢初始開發週期。在這些文檔驅動的開發人員構建API以前,依賴於使用新設計的API的團隊可能會受阻。服務器

MockAPI簡介

因爲生產力在企業中相當重要,所以工程團隊須要消除軟件開發的障礙。在缺乏API的狀況下,團隊應儘早使用MockAPI來驗證文檔以及後續的實現和集成。顧名思義,MockAPI本質上是一個虛擬的API,它接受示例請求並返回有效響應,所以開發人員可使用非生產的API。
工具

儘管有些團隊在內部構建和創建Mock服務器,用於減小代碼並提升生產率,但某些選定的第三方工具(例如Eolinker)能夠輕鬆,高效地建立MockAPI。在API模擬過程當中,文檔必須與Mock服務器保持同步。
測試

Eolinker是標準的API管理工具。基於RESTfulAPI的文檔規範使開發人員可以以簡潔而富有表現力的方式來文檔化API,並自動生成MockAPI。
url

建立一個MockAPI

爲了更好地說明文檔標準(如Eolinker)對於文檔驗證的價值,讓咱們使用一些基本的API文檔和API工具建立MockAPI。翻譯

首先,建立一些文檔。對於任何文檔驅動的開發項目,需包括如url,參數,響應和驗證之類的信息。例如,如下是簡單的用戶登錄API文檔的規範:
設計

生成API文檔後在MockAPI填寫指望信息。
blog

調用MockAPI的url,設置指望參數便可測試並用於開發。
生命週期

結語

使用MockAPI進行文檔驅動開發的簡單示例顯示了此方法的重要做用。藉助功能豐富的API文檔工具,開發人員能夠設計合理、邏輯清晰的API,而不會破壞典型的產品開發生命週期。
翻譯:Eolinker
演示工具:www.eolinker.com開發

相關文章
相關標籤/搜索