介紹一款 API 敏捷開發(fā)工具

初衷

用盡可能簡(jiǎn)單的方式，完成盡可能多的需求。通過(guò)約定的方式 實(shí)現(xiàn)統(tǒng)一的標(biāo)準(zhǔn)。告別加班，拒絕重復(fù)勞動(dòng)，遠(yuǎn)離搬磚

特性

1. 用于快速開發(fā)API接口。不再定義Controller,Service,Dao,Mybatis,xml,Entity,VO等對(duì)象和方法.

2. 可視化界面，將入?yún)⒆詣?dòng)封裝到可執(zhí)行的腳本上，支持所有關(guān)系性數(shù)據(jù)庫(kù)SQL執(zhí)行語(yǔ)句，非關(guān)系型MONGODB查詢語(yǔ)句.歡迎擴(kuò)展

3. 完全基于springboot2.x 作為springboot項(xiàng)目的stater方式集成,無(wú)侵入性，新老項(xiàng)目都能快速集成

4. 只需編寫一行代碼即可完成大部分的業(yè)務(wù)需求開發(fā)，使用難度級(jí)別（測(cè)試 or 運(yùn)維）也可參與開發(fā)

5. 在線動(dòng)態(tài)編譯，無(wú)需重啟，即時(shí)生效，多數(shù)據(jù)源操作

6. 版本控制,歷史記錄比對(duì)，回滾等功能

7. 遠(yuǎn)程一鍵發(fā)布到線上環(huán)境

8. 線上POSTMAN調(diào)試,保存POSTMAN信息或三方文檔的自動(dòng)生成，歷史調(diào)用記錄存儲(chǔ)，回塑

9. 代碼提示，SQL提示，語(yǔ)法提示

10. 用戶管理控制，安全性控制，以及歷史行為記錄

11. 經(jīng)過(guò)多次項(xiàng)目驗(yàn)證，傳統(tǒng)業(yè)務(wù)型開發(fā)，服務(wù)端效率能夠提升3-5倍，前后端聯(lián)調(diào)提升效率1倍，測(cè)試效率2倍提升

傳統(tǒng)開發(fā)步驟:

1. 增加一張表

2. 創(chuàng)建實(shí)體對(duì)象，映射這張表

3. 創(chuàng)建API入?yún)O

4. 創(chuàng)建API出參VO

5. 創(chuàng)建Controller

6. 創(chuàng)建Service

7. 創(chuàng)建Dao

8. 創(chuàng)建Mapper, xml或者JPA

9. 在mysql客戶端，或者mongo客戶端中寫執(zhí)行腳本語(yǔ)句，復(fù)制到代碼中

10. 反復(fù)重啟，進(jìn)行接口自測(cè)

11. 編寫API文檔

12. 完成一個(gè)功能點(diǎn)開發(fā)

使用一些工具比如mybatis plus，jpa，或者idea的Easy code,MybatisCodeHelperPro等可以一鍵生成一些基于單表的操作的相關(guān)代碼，但是業(yè)務(wù)場(chǎng)景來(lái)說(shuō)，可能喜歡更靈活，代碼執(zhí)行效率更高的一些操作方式,并且一個(gè)項(xiàng)目開發(fā)中，從來(lái)不僅僅是單表的一些操作操作

市面上就上面的這些問(wèn)題，提供了APIJSON和GraphQL等解決方案,這兩個(gè)工具相對(duì)操作數(shù)據(jù)庫(kù)相對(duì)很靈活，但是操作難度，和學(xué)習(xí)成本高，并且適合場(chǎng)景也是有限，如果要實(shí)現(xiàn)簡(jiǎn)單的業(yè)務(wù)處理邏輯會(huì)比較復(fù)雜

那么，我希望有一種功具，它可以像mybatis xml，像metabase BI,一樣，能夠直接操作原生的數(shù)據(jù)庫(kù)查詢及操作語(yǔ)句，并且可以有springboot的restful這種業(yè)界標(biāo)準(zhǔn)的接口定義/及參數(shù)定義方式，并且按照統(tǒng)一約定的方式，省略三層MVC的定義，并且能夠?qū)?shù)據(jù)進(jìn)行一些邏輯處理，以滿足多元化的業(yè)務(wù)需求。最好是作為一個(gè)插件的形式，能夠很好的集成在現(xiàn)有項(xiàng)目中，不會(huì)影響到現(xiàn)有的業(yè)務(wù)邏輯處理

這就是我要介紹的一款工具?Rocket API

https://gitee.com/alenfive/rocket-api-doc/wikis/pages

區(qū)別于前兩類的設(shè)計(jì)方式不同點(diǎn)在于:

1. 基于springboot開發(fā)。包括接口的注冊(cè)，參數(shù)的獲取，輸入輸出的消息轉(zhuǎn)換，都是基于springboot的生態(tài)環(huán)境，能無(wú)侵入性集成于springboot項(xiàng)目中，如果你有基于springboot實(shí)現(xiàn)了全局異常處理，返回值統(tǒng)一封裝，權(quán)限控制等，不用擔(dān)心，都在你的管控范圍內(nèi)

2. 參考于mybatis的參數(shù)定義方式，不同點(diǎn)在于使用默認(rèn)大于配置的邏輯，實(shí)現(xiàn)參數(shù)的注入直接來(lái)源于請(qǐng)求參數(shù)，省略了傳統(tǒng)MVC 實(shí)體類，方法，VO等定義

3. 默認(rèn)擔(dān)供了內(nèi)部函數(shù)，可以很簡(jiǎn)單的實(shí)現(xiàn) 多表/多庫(kù)的增/刪/改/查，導(dǎo)出，導(dǎo)入，上傳，下載，分頁(yè)查詢等功能

4. 提供了基于Groovy的語(yǔ)法解析，可以實(shí)現(xiàn)Groovy的一些邏輯處理

5. 提供了調(diào)用springboot bean對(duì)象的方法及其他任意java定義的靜態(tài)類，方法和對(duì)象，這意味著我能夠調(diào)用公共定義的類，或者之前在項(xiàng)目中定義的service,dao,和utils

6. 因?yàn)榛诘膅roovy動(dòng)態(tài)語(yǔ)法解析，所以代碼修改，或者線上問(wèn)題的處理能夠不用重啟服務(wù)，也不用升級(jí)代碼就能夠完成功能開發(fā)和問(wèn)題處理，這對(duì)開發(fā)效率而言會(huì)有很大的提升

7. 傳統(tǒng)業(yè)務(wù)開發(fā)，不僅有服務(wù)端的開發(fā)，還有相對(duì)應(yīng)的文檔生成，前后端對(duì)接，以及測(cè)試配合。“Rocket API” 提供了POSTMAN的操作頁(yè)面，能夠?qū)?shù)的請(qǐng)求值，請(qǐng)求類型，響應(yīng)等保存起來(lái)，給予前端做真實(shí)數(shù)據(jù)的對(duì)接，而不是類yapi，或者swagger之類生成的不能使用的假數(shù)據(jù)。基于這些真實(shí)的請(qǐng)求參數(shù)和返回值，提供了外部接口能力，測(cè)試團(tuán)隊(duì)可以以此來(lái)做接口的一鍵冒煙測(cè)試，和文檔的一鍵生成

演示說(shuō)明

接口功能邏輯頁(yè)面

接口功能自測(cè)頁(yè)面

文檔和演示地址：

https://gitee.com/alenfive/rocket-api-doc/wikis/pages

集成方式：

1. 添加依賴

2. 數(shù)據(jù)源配置

3. 最新建表腳本查看:

https://gitee.com/mihuajun/rocket-api-doc/wikis/pages?sort_id=2670007&doc_id=859283

啟動(dòng)項(xiàng)目，訪問(wèn)地址:

http://localhost:8080/interface-ui