更新 README.md

pull/19/head
暮光:城中城 6 years ago
parent 6c936d46b4
commit 705308938e

@ -1,11 +1,11 @@
# zyplayer-doc # zyplayer-doc
#### 说明 #### 说明
1. 本项目暂时只有swagger文档服务端的接口文档、数据库文档数据库表、字段文档的查看修改功能 1. 本项目暂时只有swagger文档服务端的接口文档dubbo文档、数据库文档(数据库表、字段文档的查看修改)功能
2. 如果需要类似文件夹、目录类的在线文档、文件管理访问权限控制暂时还没有可以提交Issues或评论说明具体需求整理需求后开发已有这方面打算最近接到比较多的这种需求 2. 如果需要类似文件夹、目录类的在线文档、文件管理访问权限控制暂时还没有可以提交Issues或评论说明具体需求整理需求后开发已有这方面打算最近接到比较多的这种需求
#### 项目介绍 #### 项目介绍
定位为所有文档的管理项目swagger文档、数据库文档....等,提供一整套的解决方案,欢迎有想法的一起来写 定位为所有文档的管理项目swagger文档、dubbo文档、数据库文档....等,提供一整套的解决方案,欢迎有想法的一起来写
#### 软件架构 #### 软件架构
##### 一、zyplayer-doc-core 一些核心、公用的类 ##### 一、zyplayer-doc-core 一些核心、公用的类
@ -23,6 +23,9 @@
##### 四、zyplayer-doc-swagger 原[swagger-mg-ui](https://gitee.com/zyplayer/swagger-mg-ui)swagger的UI及整套解决方案 ##### 四、zyplayer-doc-swagger 原[swagger-mg-ui](https://gitee.com/zyplayer/swagger-mg-ui)swagger的UI及整套解决方案
> 具有 后端存储、代理请求、模拟返回、所有文档管理 等一系列原创功能不止UI > 具有 后端存储、代理请求、模拟返回、所有文档管理 等一系列原创功能不止UI
##### 五、zyplayer-doc-dubbo 将dubbo的文档在线化管理
> 支持zookeeper、nacos的注册中心文档获取支持在线调试接口
#### 运行方式 #### 运行方式
1. 创建数据库zyplayer_doc_manage执行脚本[zyplayer_doc_manage.sql](https://gitee.com/zyplayer/zyplayer-doc/blob/master/zyplayer-doc-manage/src/main/resources/sql/zyplayer_doc_manage.sql) 1. 创建数据库zyplayer_doc_manage执行脚本[zyplayer_doc_manage.sql](https://gitee.com/zyplayer/zyplayer-doc/blob/master/zyplayer-doc-manage/src/main/resources/sql/zyplayer_doc_manage.sql)
@ -59,7 +62,16 @@ http://127.0.0.1:8082/zyplayer-doc-manage/static/manage/home.html
2. 支持多数据源,在`zyplayer-doc-manage` -> `application.yml` -> `zyplayer.doc.db.dbConfigList` 处配置多个数据库连接即可 2. 支持多数据源,在`zyplayer-doc-manage` -> `application.yml` -> `zyplayer.doc.db.dbConfigList` 处配置多个数据库连接即可
##### 三、zyplayer-doc-manage ##### 三、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的配置访问地址http://127.0.0.1:8082/zyplayer-doc-manage/doc-dubbo.html
4. 支持文档查找、文档编辑、在线调试接口
##### 四、zyplayer-doc-manage
1. 整合了上面两个功能到此项目,较少熟悉成本,`git clone`下来即可运行 1. 整合了上面两个功能到此项目,较少熟悉成本,`git clone`下来即可运行
2. 具有简单的`权限管理`、`人员管理`功能(还没想好具体怎么控制,没需求) 2. 具有简单的`权限管理`、`人员管理`功能(还没想好具体怎么控制,没需求)
@ -71,6 +83,10 @@ http://127.0.0.1:8082/zyplayer-doc-manage/static/manage/home.html
![](https://images.gitee.com/uploads/images/2018/1216/224050_3f93dd4a_596905.png "屏幕截图.png") ![](https://images.gitee.com/uploads/images/2018/1216/224050_3f93dd4a_596905.png "屏幕截图.png")
数据库文档: 数据库文档:
![](https://images.gitee.com/uploads/images/2018/1219/231332_0a95e458_596905.png "屏幕截图.png") ![](https://images.gitee.com/uploads/images/2018/1219/231332_0a95e458_596905.png "屏幕截图.png")
dubbo文档
![](https://images.gitee.com/uploads/images/2019/0214/224530_1cac5a99_596905.png "屏幕截图.png")
dubbo接口调试
![](https://images.gitee.com/uploads/images/2019/0214/224600_8dfeb0c2_596905.png "屏幕截图.png")
增加文档处: 增加文档处:
![](https://images.gitee.com/uploads/images/2019/0108/225208_6f4a9a64_596905.png "屏幕截图.png") ![](https://images.gitee.com/uploads/images/2019/0108/225208_6f4a9a64_596905.png "屏幕截图.png")
使用springfox-swagger-ui访问增加的文档 使用springfox-swagger-ui访问增加的文档

Loading…
Cancel
Save