From 33229dd85af0b26e664d58061eaaca69e1e332f1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9A=AE=E5=85=89=EF=BC=9A=E5=9F=8E=E4=B8=AD=E5=9F=8E?= <806783409@qq.com> Date: Sat, 16 May 2020 13:02:08 +0800 Subject: [PATCH] update README.md. --- README.md | 80 ++++++++++++++----------------------------------------- 1 file changed, 20 insertions(+), 60 deletions(-) diff --git a/README.md b/README.md index 0ebe26a8..f1253566 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # zyplayer-doc #### 项目介绍 -定位为所有文档的管理项目，swagger文档、dubbo文档、数据库文档、wiki、ElasticSearch文档....等，提供一整套的解决方案，为开发者服务，欢迎有想法的一起来写，给个Star鼓励下呗！（您的一个Star是快速迭代的动力源泉！） +zyplayer-doc是一款在线文档工具，现有swagger 文档、dubbo文档、数据库文档、WIKI文档、ElasticSearch文档等，管理端具有人员管理、权限管理功能等功能。项目后端使用spring-boot、mybatis-plus等框架，前端使用zui、Vue、element-ui等框架。为开发者服务，欢迎有想法的一起来写，给个Star鼓励下呗！（您的一个Star是快速迭代的动力源泉！） 欢迎加群讨论，QQ群号：466363173 体验地址：[http://doc.zyplayer.com](http://doc.zyplayer.com/zyplayer-doc-manage/) 需登录 账号：zyplayer 密码：123456 （未运行dubbo服务，不能体验dubbo文档调试） @@ -10,28 +10,25 @@ [http://doc.zyplayer.com/zyplayer-doc-manage/open-wiki.html?pageId=1&space=23f3f59a60824d21af9f7c3bbc9bc3cb](http://doc.zyplayer.com/zyplayer-doc-manage/open-wiki.html?pageId=1&space=23f3f59a60824d21af9f7c3bbc9bc3cb) -#### 软件架构 -##### 一、zyplayer-doc-core 一些核心、公用的类 +#### 模块介绍 +##### 一、zyplayer-doc-core +> 一些核心、公用的类 -##### 二、zyplayer-doc-db 数据库文档 -> 原[zyplayer-doc-db](https://gitee.com/zyplayer/zyplayer-doc-db)，具有数据库文档的查看、管理、导出等功能 +##### 二、zyplayer-doc-manage 可以单独部署的文档管理后台 +> 集成了本项目内的各子模块，具有人员及权限管理功能，是各模块的协调模块 -##### 三、zyplayer-doc-manage 可以单独部署的文档管理后台 -> 后端使用spring-boot、mybatis-plus、springfox-swagger等框架，前端使用[zui](http://zui.sexy/)、[Vue](https://cn.vuejs.org/)、[element-ui](http://element-cn.eleme.io)等框架 +##### 三、zyplayer-doc-db 数据库文档 +> 支持MySQL、SQLServer、Oracle数据源，支持数据库表、字段文档查看修改，表文档导出，SQL执行、表数据预览、不同数据库之间的数据互导，支持多数据源管理。支持按人员、按数据源对用户授权，可给用户 库表注释查看、注释修改、SQL执行 粒度的授权。目标是取代Navicat，做一个开源免费的在线数据库管理工具。 -> 已集成三套优秀swagger文档前端：[zyplayer-doc-swagger](https://gitee.com/zyplayer/zyplayer-doc)、[swagger-bootstrap-ui](https://gitee.com/xiaoym/swagger-bootstrap-ui)、[springfox-swagger-ui](https://github.com/springfox/springfox/tree/master/springfox-swagger-ui) +##### 四、zyplayer-doc-wiki wiki文档工具 +> 在线管理公司、项目及任意形式的文档，文档支持按空间划分，在线编辑查看，支持附件上传下载，支持评论、点赞及权限设置等。参考学习了Atlassian Confluence文档工具进行开发，争取作为该软件的开源免费替代产品，同时作为内部文档管理工具最好的存在。 -> 已集成本项目内的各子模块，可直接使用 +##### 五、zyplayer-doc-swagger，swagger的UI及整套解决方案 +> 支持swagger的文档展示，接口调试，文档导出等，解析速度快，界面设计走心。支持将所有的swagger文档进行统一管理，支持全局参数设置，请求参数缓存，下次自动填充等。目标是解决swagger官方文档查看及接口调试不方便的问题。 -##### 四、zyplayer-doc-swagger 原[swagger-mg-ui](https://gitee.com/zyplayer/swagger-mg-ui)，swagger的UI及整套解决方案 -> 具有 后端存储、代理请求、模拟返回、所有文档管理 等一系列原创功能，不止UI - -##### 五、zyplayer-doc-dubbo 将dubbo的文档在线化管理 +##### 六、zyplayer-doc-dubbo 将dubbo的文档在线化管理 > 支持zookeeper、nacos的注册中心文档获取，支持在线调试接口 -##### 六、zyplayer-doc-wiki wiki文档工具 -> 支持文档创建、展示，文件上传、下载，空间隔离，开放文档访问等 - ##### 七、zyplayer-doc-grpc grpc文档工具 > 用比较变态的方式实现了grpc的文档和在线调试功能，通过http的方式来请求grpc的接口 @@ -40,6 +37,9 @@ ##### 八、zyplayer-doc-es ElasticSearch文档工具 > 支持ElasticSearch的文档查看和执行DSL查询的功能 +##### 九、zyplayer-doc-ui +> 前面各模块的前端UI源码 + #### 运行方式 1. 创建数据库：zyplayer_doc_manage，执行脚本：[zyplayer_doc_manage.1.0.5.sql](https://gitee.com/zyplayer/zyplayer-doc/blob/master/zyplayer-doc-manage/src/main/resources/sql/zyplayer_doc_manage.1.0.5.sql) @@ -48,49 +48,9 @@ 3. 启动zyplayer-doc-manage项目，访问地址：http://127.0.0.1:8083/zyplayer-doc-manage/ -#### 模块介绍 - -##### 一、zyplayer-doc-swagger -1. 在 `zyplayer-doc-swagger`->`文档管理`->`文档地址管理` 页可以管理`任意地址`的文档，在集成的三套UI中都可以直接查看和调试这里配置的文档，不用对UI做任何调整，只要标准的UI集成进来也可以直接用 - -2. 文档展示配置，`自动填充请求参数`：可配置填充级别，`强制重写域名`：文档在本地想调试线上接口的好帮手，`自动保存请求参数`：不用每次输入 - -3. 可配置`全局参数`，放在header或param里的 - -4. 可对`调试数据`进行管理 - -5. `模拟返回`：前端自行调试接口的好帮手 - -6. 私人强迫症级定制化文档展示，清晰明了，参数支持批量编辑，每一条线的间距都考量了半天，支持`文件上传`的调试，需要指定dataType = `File`或`MultipartFile`，例： - -@ApiImplicitParam(name = "file", value = "文件", dataType = "File", allowMultiple = true) - -7. 后端代理请求，后端存储，不会存在任何跨域问题 - -##### 二、zyplayer-doc-db -1. 支持Mysql、SQLserver的数据库表、字段文档查看修改，导出，展示关系图等功能 - -2. 支持多数据源，在`zyplayer-doc-manage` -> `application.yml` -> `zyplayer.doc.db.dbConfigList` 处配置多个数据库连接即可 - -##### 三、zyplayer-doc-dubbo -1. `zyplayer-doc-manage` -> `application.yml` -> `zyplayer.dubbo.zookeeper.url` 配置zookeeper地址 - -2. `zyplayer-doc-manage` -> `application.yml` -> `zyplayer.dubbo.nacos.url` 配置nacos服务地址 - -3. 默认找zookeeper，未配置再找nacos的配置 - -4. 支持文档查找、文档编辑、在线调试接口 - -5. 自动获取参数列表需要指定的类存在，所以请在 pom.xml -> dependencies 最后加上服务所在的包，后端才能通过Class.forName("xx");来找到参数列表，减少录入成本 - -6. 数组或List参数，调试参数录入格式例：[1,2] ，后端通过JSON工具转成指定类型，有不支持的类型时欢迎反馈 - -##### 四、zyplayer-doc-manage -1. 整合了上面两个功能到此项目，较少熟悉成本，`git clone`下来即可运行 - -2. 具有简单的`权限管理`、`人员管理`功能 - -3. 使用最新的一些技术框架，很简单，初学者拿来学习也是很不错的 - 更多详细的使用部署文档：http://doc.zyplayer.com/zyplayer-doc-manage/open-wiki.html?pageId=1&space=23f3f59a60824d21af9f7c3bbc9bc3cb +#### 界面展示 +![主页面](https://images.gitee.com/uploads/images/2020/0516/125840_d6284954_596905.png "主页面.png") +![数据库文档](https://images.gitee.com/uploads/images/2020/0516/130017_254f9559_596905.png "数据库文档.png") +![wiki文档](https://images.gitee.com/uploads/images/2020/0516/130119_bc2f5021_596905.png "wiki文档.png")