# DX-ANT-DOC

**Repository Path**: jiangww007/DX-ANT-DOC

## Basic Information

- **Project Name**: DX-ANT-DOC
- **Description**: antd技术开发的swagger接口调试应用
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 5
- **Forks**: 0
- **Created**: 2020-06-28
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# DX_ANT_DOC 简介

- **DX_ANT_DOC是一款接口文档生成和调试工具**
- **接口必须为spring rest，并且应用swagger2.x**
- **界面使用antd pro v5**
- **后端使用spring boot 2.x**

## 适用对象

- **后端开发人员：**
 >* 开发的接口能快速进行调试，支持调试数据自动赋值；
 >* 支持多种请求类型：POST、GET普通接口,POST、GET文件上传及下载接口；
 >* 调试参数和返回参数能按结构化显示；
- **前端开发人员：**
 >* 前端开发人员可以查看对应接口，快速定位接口入参，及返回值，方便前端调试和开发；
- **写接口文档的人：**
 >* 本系统可以自动生成所有接口的markdown文件，稍加修改即可成为一个接口文档；

---

**Demo： http://49.233.23.145:8088/dx_antw_doc.html**
clientID随便输入，version 输入v1 v2 等

>网络带宽有点低,请耐心等待......

**本演示地址的项目为spring boot + dubbo，主要实现了以下功能**
 * 扩展了dubbo协议支持spring JMS，只需简单修改协议名为jms即可，主要作用是穿网，相信一些做ZF相关项目的会遇到这种奇葩要求；
 >简单描述穿网：dubbo协议是找到服务，远程调用provider的服务，而一些特殊部门的网络要求是，外网不能调用内网服务，所以要求外网发送消息告诉内网要请求哪个服务，内网接到消息后，执行服务，并把结果发消息到消息服务器上，然后外网consumer端到消息服务器上获取结果。
 * 实现了一套基础crud，接口开发时基本的crud通过继承和泛型原理，不需重新开发即可使用；
 * 架构按照面向对象原则，先设计javabean，然后根据对象自动生成数据库对象；
 * 虽然使用了hibernate，但重新封装了命名查询，使支持类似mybatis的动态sql查询语句；
 * 其他......spring boot dubbo hibernate redis activeMQ activiti等开源技术；
 
 **注：扩展的JMS协议的效率无法跟dubbo协议效率相比，这种扩展也是为了应对一些特殊需求，并不是突发奇想，觉得dubbo协议不好**
>**关于此项目**
>* 目前只实现了基础架构功能，所以仓库还未公开；
>* 目前本框架特色：
>>* 支持单包部署（consumer和provider合并部署）；**适用于小企业的管理系统；**
>>* 分包部署（consumer和provider分开部署，支持原生的dubbo各种协议的基础上扩展了JMS、kafka协议）；**适用于想分布式、建立微服务的系统；**
>>* 因为基于spring cloud、spring boot 技术，所以也具备可扩展性、微服务等能力和优势；
---

## 安装

- **将dxapAntw下的jar放入私有仓库依赖或lib下**
- **根据自身项目做类似如下配置:**
**public class WebMvcConfig extends WebMvcConfigurationSupport**

```java
@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);
    }

```

## 使用

- **项目启动后，浏览器中输入：项目地址/dx_ant_doc.html**
- **例如 http ://localhost:8088/dx_ant_doc.html**



## 更新历史

- **2020-7-20 v1.0;**

## BUG 修复

- **2020-7-27 修复了...**
- **2020-7-27 修复了...**

## License

MIT © [dx_app](http://49.233.23.145:8088/dx_antw_doc.html)