初衷
用盡可能簡單的方式,完成儘可能多的需求。通過約定的方式 實現統一的標準。告別加班,拒絕重複勞動,遠離搬磚
特性
- 用於快速開發API接口。不再定義
Controller
,Service
,Dao
,Mybatis
,xml
,Entity
,VO
等對象和方法. - 可視化界面,將入參自動封裝到可執行的腳本上,支持所有關係性數據庫SQL執行語句,非關係型
MONGODB
查詢語句.歡迎擴展 - 完全基於springboot2.x 作爲springboot項目的stater方式集成,無侵入性,新老項目都能快速集成
- 只需編寫一行代碼即可完成大部分的業務需求開發,使用難度級別(測試 or 運維)也可參與開發
- 在線動態編譯,無需重啓,即時生效,多數據源操作
- 版本控制,歷史記錄比對,回滾等功能
- 遠程一鍵發佈到線上環境
- 線上POSTMAN調試,保存POSTMAN信息或三方文檔的自動生成,歷史調用記錄存儲,回塑
- 代碼提示,SQL提示,語法提示
- 用戶管理控制,安全性控制,以及歷史行爲記錄
- 經過多次項目驗證,傳統業務型開發,服務端效率能夠提升3-5倍,前後端聯調提升效率1倍,測試效率2倍提升
傳統開發步驟:
- 增加一張表
- 創建實體對象,映射這張表
- 創建API入參VO
- 創建API出參VO
- 創建Controller
- 創建Service
- 創建Dao
- 創建Mapper, xml或者JPA
- 在mysql客戶端,或者mongo客戶端中寫執行腳本語句,複製到代碼中
- 反覆重啓,進行接口自測
- 編寫API文檔
- 完成一個功能點開發
使用一些工具比如mybatis plus,jpa,或者idea的Easy code,MybatisCodeHelperPro等可以一鍵生成一些基於單表的操作的相關代碼,但是業務場景來說,可能喜歡更靈活,代碼執行效率更高的一些操作方式,並且一個項目開發中,從來不僅僅是單表的一些操作操作市面上就上面的這些問題,提供了APIJSON和GraphQL等解決方案,這兩個工具相對操作數據庫相對很靈活,但是操作難度,和學習成本高,並且適合場景也是有限,如果要實現簡單的業務處理邏輯會比較複雜那麼,我希望有一種功具,它可以像mybatis xml,像metabase BI,一樣,能夠直接操作原生的數據庫查詢及操作語句,並且可以有springboot的restful這種業界標準的接口定義/及參數定義方式,並且按照統一約定的方式,省略三層MVC的定義,並且能夠對數據進行一些邏輯處理,以滿足多元化的業務需求。最好是作爲一個插件的形式,能夠很好的集成在現有項目中,不會影響到現有的業務邏輯處理這就是我要介紹的一款工具 #Rocket API#區別於前兩類的設計方式不同點在於:
- 基於springboot開發。包括接口的註冊,參數的獲取,輸入輸出的消息轉換,都是基於springboot的生態環境,能無侵入性集成於springboot項目中,如果你有基於springboot實現了全局異常處理,返回值統一封裝,權限控制等,不用擔心,都在你的管控範圍內
- 參考於mybatis的參數定義方式,不同點在於使用默認大於配置的邏輯,實現參數的注入直接來源於請求參數,省略了傳統MVC 實體類,方法,VO等定義
- 默認擔供了內部函數,可以很簡單的實現 多表/多庫的增/刪/改/查,導出,導入,上傳,下載,分頁查詢等功能
- 提供了基於Groovy的語法解析,可以實現Groovy的一些邏輯處理
- 提供了調用springboot bean對象的方法及其他任意java定義的靜態類,方法和對象,這意味着我能夠調用公共定義的類,或者之前在項目中定義的service,dao,和utils
- 因爲基於的groovy動態語法解析,所以代碼修改,或者線上問題的處理能夠不用重啓服務,也不用升級代碼就能夠完成功能開發和問題處理,這對開發效率而言會有很大的提升
- 傳統業務開發,不僅有服務端的開發,還有相對應的文檔生成,前後端對接,以及測試配合。“Rocket API” 提供了POSTMAN的操作頁面,能夠將參數的請求值,請求類型,響應等保存起來,給予前端做真實數據的對接,而不是類yapi,或者swagger之類生成的不能使用的假數據。基於這些真實的請求參數和返回值,提供了外部接口能力,測試團隊可以以此來做接口的一鍵冒煙測試,和文檔的一鍵生成
接口功能邏輯頁面
接口功能自測頁面
文檔和演示地址:https://gitee.com/alenfive/rocket-api-doc/wikis/pages
集成方式:
1. 添加依賴
<dependency>
<groupId>com.github.alenfive</groupId>
<artifactId>rocket-api-boot-starter</artifactId>
<version>0.0.1-SNAPSHOT</version>
</dependency>
2. 數據源配置
@Component
public class DefaultDataSourceManager extends DataSourceManager {
@Autowired
private JdbcTemplate jdbcTemplate;
@PostConstruct
public void init() {
Map<String,DataSourceDialect> dialects = new HashMap<>();
dialects.put("mysql",new SqlDataSource(jdbcTemplate,true));
super.setDialectMap(dialects);
}
}
3. 最新建表腳本查看:
https://gitee.com/alenfive/rocket-api-doc/wikis/pages?sort_id=2670007&doc_id=859283
啓動項目,訪問地址: http://localhost:8080/interface-ui