DX-ANT-DOC接口文檔生成和調(diào)試工具

DX_ANT_DOC是一款接口文檔生成和調(diào)試工具。

• 接口必須為spring rest，并且應(yīng)用swagger2.x
• 界面使用antd pro v5
• 后端使用spring boot 2.x

適用對(duì)象

• 后端開發(fā)人員：

• 開發(fā)的接口能快速進(jìn)行調(diào)試，支持調(diào)試數(shù)據(jù)自動(dòng)賦值；
• 支持多種請(qǐng)求類型：POST、GET普通接口,POST、GET文件上傳及下載接口；
• 調(diào)試參數(shù)和返回參數(shù)能按結(jié)構(gòu)化顯示；

• 前端開發(fā)人員：

• 前端開發(fā)人員可以查看對(duì)應(yīng)接口，快速定位接口入?yún)ⅲ胺祷刂?，方便前端調(diào)試和開發(fā)；

• 寫接口文檔的人：

• 本系統(tǒng)可以自動(dòng)生成所有接口的markdown文件，稍加修改即可成為一個(gè)接口文檔；

Demo： http://49.233.23.145:8088/dx_antw_doc.html clientID隨便輸入，version 輸入v1 v2 等

網(wǎng)絡(luò)帶寬有點(diǎn)低,請(qǐng)耐心等待......

本演示地址的項(xiàng)目為spring boot + dubbo，主要實(shí)現(xiàn)了以下功能

• 擴(kuò)展了dubbo協(xié)議支持spring JMS，只需簡(jiǎn)單修改協(xié)議名為jms即可，主要作用是穿網(wǎng)，相信一些做ZF相關(guān)項(xiàng)目的會(huì)遇到這種奇葩要求；

簡(jiǎn)單描述穿網(wǎng)：dubbo協(xié)議是找到服務(wù)，遠(yuǎn)程調(diào)用provider的服務(wù)，而一些特殊部門的網(wǎng)絡(luò)要求是，外網(wǎng)不能調(diào)用內(nèi)網(wǎng)服務(wù)，所以要求外網(wǎng)發(fā)送消息告訴內(nèi)網(wǎng)要請(qǐng)求哪個(gè)服務(wù)，內(nèi)網(wǎng)接到消息后，執(zhí)行服務(wù)，并把結(jié)果發(fā)消息到消息服務(wù)器上，然后外網(wǎng)consumer端到消息服務(wù)器上獲取結(jié)果。

• 實(shí)現(xiàn)了一套基礎(chǔ)crud，接口開發(fā)時(shí)基本的crud通過繼承和泛型原理，不需重新開發(fā)即可使用；
• 架構(gòu)按照面向?qū)ο笤瓌t，先設(shè)計(jì)javabean，然后根據(jù)對(duì)象自動(dòng)生成數(shù)據(jù)庫(kù)對(duì)象；
• 雖然使用了hibernate，但重新封裝了命名查詢，使支持類似mybatis的動(dòng)態(tài)sql查詢語(yǔ)句；
• 其他......spring boot dubbo hibernate redis activeMQ activiti等開源技術(shù)；

注：擴(kuò)展的JMS協(xié)議的效率無(wú)法跟dubbo協(xié)議效率相比，這種擴(kuò)展也是為了應(yīng)對(duì)一些特殊需求，并不是突發(fā)奇想，覺得dubbo協(xié)議不好

關(guān)于此項(xiàng)目

• 目前本框架特色：

• 支持單包部署（consumer和provider合并部署）；適用于小企業(yè)的管理系統(tǒng)；
• 分包部署（consumer和provider分開部署，支持原生的dubbo各種協(xié)議的基礎(chǔ)上擴(kuò)展了JMS、kafka協(xié)議）；適用于想分布式、建立微服務(wù)的系統(tǒng)；
• 因?yàn)榛趕pring cloud、spring boot 技術(shù)，所以也具備可擴(kuò)展性、微服務(wù)等能力和優(yōu)勢(shì)；

安裝

• 將dxapAntw下的jar放入私有倉(cāng)庫(kù)依賴或lib下
• 根據(jù)自身項(xiàng)目做類似如下配置: public class WebMvcConfig extends WebMvcConfigurationSupport

@Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {      registry.addResourceHandler("dx_antw_doc.html").addResourceLocations("classpath:/dxap_antw_doc/web/");
        registry.addResourceHandler("/**").addResourceLocations("classpath:/dxap_antw_doc/dist/");
        super.addResourceHandlers(registry);
    }

使用

• 項(xiàng)目啟動(dòng)后，瀏覽器中輸入：項(xiàng)目地址/dx_ant_doc.html
• 例如 http ://localhost:8088/dx_ant_doc.html

License

MIT ? dx_app