大家好,時隔一個月,我們又又又發佈啦,本月的主題是:團隊協作。
在開發模式是前後端協作的團隊裏,分享 API 文檔信息會是前後端對接過程中重要的一環,我想在這次月報分享下我們工具推薦的開發流程。
知乎上有一個熱門問題:後端人員先開發後給文檔合理嗎?
我認為不合理,換位思考了下在這種開發模式下的前端人員,對接的過程應該蠻痛苦,前端開發的能力和經驗決定後續改動代碼的痛苦程度。
涉及到多人共同協作完成一件事的時候,不應該把設計任務只交給其中的某一個人,應該先交流和溝通,將設計的流程前置,並用文檔記錄設計的過程和結果。
就像開發人員總會吐槽產品文檔沒寫清楚一樣,前端人員也會吐槽後端不給文檔或者寫不清楚,這個問題可以通過引入一個能協作設計並展示清晰的 API 信息的工具(明示 Eoapi)解決。
你可以考慮在 Eoapi 嘗試採用以下簡易的協作流程:
- 設計接口原型,寫接口文檔;
- 前後端同步寫代碼,根據文檔對接;
- 在對接過程中獲得的信息優化接口原型,重複過程。
更直觀一些,兩種協作流程的對比如圖:
其實工作都是這些工作,但將設計的過程提前可以減少很多協作問題。
朋友們,相信我,想通過不寫文檔節省的時間最終都會在對接扯皮過程中還給我們;而且人多力量大嘛,不同的人有不同的角度,觀點碰撞可以讓設計更好更全面。
當然,決定在設計過程中投入多少時間和精力是需要根據團隊的情況調配的,團隊很有默契不用約定也能設計一致,那文檔什麼時候寫就不太重要了,適合自己團隊的流程就是最好的。
空間是什麼?
我們在這個版本引入了空間的概念,一個空間一般是一個團隊,我們可以往空間裏添加隊友:
加入後就可以一起愉快地共享 API 和環境等空間內數據啦~
想起在月初的時候,有用户懇(wei)請(xie)我們一定一定一定不要做登錄的功能,我理解他的核心的訴求其實是打開就能用,別整那麼多花裏胡哨的。
作為 Eoapi 的產品和開發我想説:放心吧,如果你用不上雲端的功能,那就沒有登錄的必要,在本地空間內盡情使用吧~
如何使用
在服務端運行下面命令使用 Docker 一鍵啓動。
git clone https://github.com/eolinker/eoapi-remote-server
cd eoapi-remote-server
docker-compose up -d --build
在客户端中配置雲服務地址點擊連接後就可以將數據上傳到雲端啦。
配置這一塊我們設計得十分簡單,隱藏了很多配置細節,界面提示可以指引你快速上手新功能。例如初始化時可以讓你選擇將本地的數據同步到雲端。
後續計劃
Web 部署
目前我們都是通過桌面端使用的,有的用户會覺得部署和更新不太方便。
所以我們接下來會推出 Web 版本,方便大家打開瀏覽器就能使用(我個人更喜歡 Web 應用)~其實桌面端有桌面端的好處,方便找,加載快,不需要部署,蘿蔔青菜各有所愛。
API 分享
正在開發中,相信很快就能在 v1.9.0 和大家見面啦。
使用很簡單,一鍵就可以通過分享鏈接快速將 API 分享給相關的人員。原型圖淺看一下:
獲得 GVP
除了新版本發佈,還有一個好消息!本月我們的開源項目終於也獲得了 Gitee 官方的認可,榮獲 Gitee 年度最有價值的開源項目稱號——GVP,謝謝官方的認可!謝謝各位用户的支持!
努力提升用户體驗是我們做開源項目的初心,儘管我們的項目在 Gitee 上傳代碼不久,但為了讓所有用户能有較好的下載體驗,我們會在後續任何一個新版本發佈的第一時間同步 Gitee 。
我們會努力做好項目,也希望我們的項目能繼續得到你們的大力支持!關於項目,如果你有任何的疑問或者建議,老規矩,記得去 Github 或者 Gitee 上提 Issue ,我們會第一時間處理。
在線 Demo:https://www.eoapi.io/?utm_sou...
在線文檔:https://docs.eoapi.io/?utm_so...
Github:https://github.com/eolinker/e...
Gitee:https://gitee.com/eolink_admi...