Rust開發的一款接口設計工具Panda api

Panda api是一款接口設計工具，它可以生成文檔、提供接口模擬服務(在你沒寫任何代碼以前)、自動測試後端接口，有效提高項目的開發效率和質量。

爲何要用Panda Api?

提高開發效率 和 開發質量:

Panda Api 可以在開發過程當中隔離先後端，讓前端爲所欲爲的掌控接口的請求和返回，而不須要後端開發人員介入。開發環境是影響研發效能最大的一個因素之一，不穩定的上游接口環境會讓一個很是簡單的需求輕鬆消耗掉數天的時間。當後端的接口還未開發完成，或者接口突然由於後端某個開發中的功能忽然不能工做時，Panda api能夠快速提供接口。

Panda Api能夠提供一個很是高效的前端開發環境和後端測試環境，什麼是一個好的開發環境呢？

一、穩定

好的開發環境應該是穩定可用的，不該該在開發過程當中受到其餘開發人員影響，服務頻繁掛掉或者頻繁改變，先後端開發的團隊成員就深有體會，兩邊相互影響，而後又致使相互等待，很是影響開發狀態和效率。然而不少團隊一直是在以這樣低效的方式在推動。

二、快速驗證

修改代碼可以在儘量短的時間內獲得驗證也是一個基本訴求，這也是爲何大部分前端構建都會關注 Hot reload 和更高級的HMR 。有些場景下一次簡單前端的修改就要通過長時間等待等待後端開發完成，例如依賴上游修改接口的返回內容，須要修改後端的程序而後從新部署，須要走一遍完整的發佈流程來測試某個修改調整，這種改一行等幾十分鐘的開發方式對效率的拖累是極其恐怖的。

三、一致性

不少項目，由於參與人員少，以爲不須要寫什麼文檔，直接就討論後開始開發。開發到後面就會發現，你們的共識是不一致的，進一步引起爭論和項目的從新調整，若是中途換人或者半年之後再來維護這個項目，就很容易變成一個可怕的泥潭，全部人都不肯意去碰。緣由就是一開始咱們就沒有造成文檔。傳統的接口文檔確實很費時間，Panda api把文檔即服務作好，寫文檔變成了一個更高效的開發方式。

開發者對於當前的需求應該是有確切認知的，而不是一直不停的懷疑本身的理解到底對不對，相關接口的字段是什麼意思。

Panda Api是如何解決好這幾個問題

Panda Api的三個核心服務：

1. 提供先後端的開發的接口文檔
2. 提供前端開發的接口服務
3. 能夠進行後端接口測試

Panda Api 接口文檔的工具提供如下功能：

1. 提供一份能夠先後端瀏覽的接口文檔
2. 使用json或json5語法來寫文檔，操做成本、學習成本很是低
3. 接口文檔也能夠像代碼同樣進行版本控制，先後端都有維護的權限。Panda api依賴git等版本管理工具來作
4. 能夠在定義好文檔後，當即爲前端開發提供接口服務，不用等待後端開發完成。爲前端支持各種請求:GET, POST, PUT, DELETE, OPTIONS
5. 可使用這個工具進行前端測試和後端測試
6. 能夠像Mock同樣，自動生成相關測試數據

Todo 還在設計開發的功能

1. 支持多種開發環境切換，例如開發環境、測試環境、正式環境
2. 支持websocket方式爲前端開發提供測試接口服務；支持用websocket方式做爲客戶端進行後端服務測試
3. 其它等你使用後來告訴我

Panda Api 項目地址:

https://github.com/arlicle/panda-api