完善文档
This commit is contained in:
暮光：城中城
@@ -42,7 +42,7 @@ zyplayer-doc是一款在线文档工具，现有swagger 文档、dubbo文档、
|
||||
|
||||
#### 运行方式
|
||||
|
||||
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)
|
||||
1. 创建数据库：zyplayer_doc_manage，执行脚本：[zyplayer_doc_manage.1.0.6.sql](https://gitee.com/zyplayer/zyplayer-doc/blob/master/zyplayer-doc-manage/src/main/resources/sql/zyplayer_doc_manage.1.0.6.sql)
|
||||
|
||||
2. 修改zyplayer-doc-manage项目的application.yml配置文件里面的数据库账号密码
|
||||
|
||||
|
||||
@@ -1,53 +1,6 @@
|
||||
# zyplayer-doc-db
|
||||
|
||||
#### 项目介绍
|
||||
数据库文档工具，网页方式管理，只需两步即可对表注释、字段注释进行查看、修改、导出等操作，支持字段或注释的模糊查询，只有一个单独的页面，方便集成到已有的管理系统里面，本工具不对数据源进行管理，因为后台管理系统肯定是已有的数据源，没必要再来创建，只需要注入数据源即可管理
|
||||
数据库文档、管理工具，对表注释、字段注释进行查看、修改、导出等操作，支持字段或注释的模糊查询
|
||||
|
||||
按照指定的格式可展示表的关系图，展示样式见下图
|
||||
本关系图不是通过外键生成，所以需要在字段注释最后按规则添加外键关系才能生成图表，支持的格式有：
|
||||
1. T:表，例：XXX(字段注释)，T:user_info
|
||||
2. T:表.关联ID，例：XXX(字段注释)，T:user_info.id
|
||||
3. T:库.表.关联ID，例：XXX(字段注释)，T:order_db.user_info.id
|
||||
|
||||
关系图为实验功能，有更好的建议或展示方式欢迎提交建议！
|
||||
|
||||
当前支持SqlServer、mysql的管理，后期加上oracle和其他数据库的支持
|
||||
|
||||
#### 使用方式
|
||||
1. 添加注解：@EnableDocDb
|
||||
2. 注入Bean
|
||||
|
||||
```
|
||||
// 注入已有的数据源
|
||||
@Resource DataSource orderDatasource;
|
||||
@Resource DataSource userDatasource;
|
||||
|
||||
//....
|
||||
|
||||
@Bean
|
||||
public DatabaseRegistrationBean databaseRegistrationBean() {
|
||||
DatabaseRegistrationBean bean = new DatabaseRegistrationBean();
|
||||
List<DataSource> dataSourceList = new LinkedList<>();
|
||||
// 设置需要展示的数据源
|
||||
dataSourceList.add(orderDatasource);
|
||||
dataSourceList.add(userDatasource);
|
||||
bean.setDataSourceList(dataSourceList);
|
||||
return bean;
|
||||
}
|
||||
```
|
||||
|
||||
3. 打开网页访问域名地址+doc-db.html即可，例：http://192.168.0.100:8080/doc-db.html
|
||||
|
||||
#### 界面展示
|
||||
基本界面：
|
||||
|
||||
模糊查询：
|
||||
|
||||
表注释修改：
|
||||
|
||||
文档导出：
|
||||
|
||||
导出文档查看：
|
||||
|
||||
表关联关系图：
|
||||
|
||||
支持MySQL、SQLServer、Oracle数据源，支持数据库表、字段文档查看修改，表文档导出，SQL执行、表数据预览、不同数据库之间的数据互导，支持多数据源管理。支持按人员、按数据源对用户授权，可给用户 库表注释查看、注释修改、SQL执行 粒度的授权。目标是取代Navicat，做一个开源免费的在线数据库管理工具。
|
||||
|
||||
@@ -7,22 +7,6 @@ zyplayer-doc-swagger是swagger的一个前端实现，使用简单、解析速
|
||||
|
||||
欢迎多多Star！右上角↗
|
||||
|
||||
demo代码地址：
|
||||
[zyplayer-doc-swagger-demo](https://gitee.com/zyplayer/zyplayer-doc-swagger-demo)
|
||||
|
||||
已上传至中央仓库，使用方法：
|
||||
|
||||
1、添加依赖
|
||||
```
|
||||
<!-- https://mvnrepository.com/artifact/com.zyplayer/zyplayer-doc-swagger -->
|
||||
<dependency>
|
||||
<groupId>com.zyplayer</groupId>
|
||||
<artifactId>zyplayer-doc-swagger</artifactId>
|
||||
<version>1.0.6</version>
|
||||
</dependency>
|
||||
```
|
||||
2、启动后访问：[http://localhost:8080/document.html](http://localhost:8080/document.html)
|
||||
|
||||
#### 服务器端的存储 功能：
|
||||
实现MgStorageService并申明为@Service之后网页上才能使用服务器端的存储能力，同时需要在@EnableSwagger2的地方添加@EnableSwaggerMgUi注解，才能开启存储的接口
|
||||
|
||||
@@ -30,9 +14,6 @@ demo代码地址：
|
||||
所有网页的配置、调试值都可以存储到服务器的数据库中，便于团队所有人的调试，一人配置，所有人受益
|
||||
如果不开启的话，数据是存放在浏览器的localStorage中，每个人、每个浏览器都得配置一次才能使用
|
||||
|
||||
开启@EnableSwaggerMgUi注解坏处：
|
||||
暴露了一个请求任意地址的接口，比如任意内部接口，所以不建议在线上项目开启此注解，单独的本地的文档管理项目才开启，不会对外暴露此接口，切记！！！！
|
||||
|
||||
还有线上项目切记关闭swagger的接口扫描，不然别人就能拿到服务器的所有接口了，专门的对外文档还是可以，但还是尽量关闭，使用本项目的文档导出功能给第三方！
|
||||
|
||||
#### 模拟请求拦截 功能：
|
||||
@@ -46,8 +27,6 @@ demo代码地址：
|
||||
也许需要10天才能写完，但前端两天就写好了，急需数据看效果，这时就让他们自己去设置模拟值，加上参数自己测试好。
|
||||
而不是一味的催后台，把各种锅丢给后端，然后玩自己的去了，浪费各环节等待时间。
|
||||
|
||||
#### ↑↑以上个性化功能在demo中都有写到，欢迎体验↑↑：
|
||||
|
||||
如果需要看多个项目的文档，不再需要对让被访问的项目支持跨域访问！因为已集成服务器端代理请求，想请求什么都行！把在线调试当postman来用都行！（虽然功能差得远，但基础的用是没问题的，够用就行，不断完善中）
|
||||
|
||||
#### 功能细节：
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
1、命令行要进入这个文件夹才能执行命令：
|
||||
|
||||
zyplayer-doc/zyplayer-doc-ui/manage-ui
|
||||
zyplayer-doc/zyplayer-doc-ui/console-ui
|
||||
|
||||
2、增加host，否则run不起来：
|
||||
|
||||
@@ -20,7 +20,7 @@ zyplayer-doc-ui/manage-ui/src/common/config/apimix.js
|
||||
|
||||
2、这里可以配置启动后访问的地址，建议不改
|
||||
|
||||
zyplayer-doc-ui/manage-ui/webpack.config.js
|
||||
zyplayer-doc-ui/console-ui/webpack.config.js
|
||||
|
||||
## 环境要求
|
||||
|
||||
|
||||
@@ -1,28 +1,47 @@
|
||||
# zyplayer-doc-db项目的UI
|
||||
|
||||
## 常见问题
|
||||
|
||||
1、命令行要进入这个文件夹才能执行命令：
|
||||
|
||||
zyplayer-doc/zyplayer-doc-ui/db-ui
|
||||
|
||||
2、修改host，否则run不起来：
|
||||
|
||||
在文件 C:\Windows\System32\drivers\etc\hosts 末尾增加：
|
||||
|
||||
127.0.0.1 local.zyplayer.com
|
||||
|
||||
## 配置文件
|
||||
|
||||
配置开发环境和线上环境的请求域名地址：
|
||||
开发环境：.env.development
|
||||
线上环境：.env.production
|
||||
|
||||
## 环境要求
|
||||
|
||||
`Node >= 6`
|
||||
|
||||
|
||||
## 开始
|
||||
|
||||
``` bash
|
||||
# 执行下面的命令初始化
|
||||
yarn
|
||||
npm install
|
||||
```
|
||||
|
||||
## 开发环境
|
||||
|
||||
``` bash
|
||||
# 执行下面的命令后即可到 localhost:8010 看到页面
|
||||
# 执行下面的命令后即可到启动前端工程
|
||||
npm run dev
|
||||
```
|
||||
|
||||
## 打包
|
||||
|
||||
``` bash
|
||||
# 开发完成后执行打包命令，然后复制dist目录里的文件到zyplayer-doc-manage项目的webjars目录下即可
|
||||
# 打包前记得修改zyplayer-doc-ui/manage-ui/src/common/config/apimix.js里的HOST接口地址
|
||||
npm run build
|
||||
# 开发完成后执行打包命令，然后复制dist目录里的文件到zyplayer-doc-db/resources目录下
|
||||
# 复制完成后记得修改index.html为doc-db.html
|
||||
# todo：是否可以直接打包为：doc-db.html，不用手动改名字
|
||||
# todo：是否可以直接打包到zyplayer-doc-db/resources文件夹下，难得复制
|
||||
```
|
||||
|
||||
@@ -3,6 +3,7 @@ zyplayer-doc-wiki项目的UI使用此项目构建，开发起来爽得很，
|
||||
但是，才发第一版，又他喵得重构一次~
|
||||
之前从jQuery换到element以为是结局了，爽到吐，结果又被这个迷住了，前端真是让人高潮个不停啊，
|
||||
但是，好东西怎么放过呢！
|
||||
---来自一个前端新手的BB
|
||||
|
||||
## 常见问题
|
||||
|
||||
@@ -10,7 +11,7 @@ zyplayer-doc-wiki项目的UI使用此项目构建，开发起来爽得很，
|
||||
|
||||
zyplayer-doc/zyplayer-doc-ui/wiki-ui
|
||||
|
||||
2、增加host，否则run不起来：
|
||||
2、修改host，否则run不起来：
|
||||
|
||||
在文件 C:\Windows\System32\drivers\etc\hosts 末尾增加：
|
||||
|
||||
@@ -18,37 +19,34 @@ zyplayer-doc/zyplayer-doc-ui/wiki-ui
|
||||
|
||||
## 配置文件
|
||||
|
||||
1、这里可以配置接口请求的域名，可使用本地、线上，测试通过后就会打包到zyplayer-doc-wiki项目里面使用
|
||||
|
||||
zyplayer-doc-ui/wiki-ui/src/common/config/apimix.js
|
||||
|
||||
2、这里可以配置启动后访问的地址，建议不改
|
||||
|
||||
zyplayer-doc-ui/wiki-ui/webpack.config.js
|
||||
配置开发环境和线上环境的请求域名地址：
|
||||
开发环境：.env.development
|
||||
线上环境：.env.production
|
||||
|
||||
## 环境要求
|
||||
|
||||
`Node >= 6`
|
||||
|
||||
|
||||
## 开始
|
||||
|
||||
``` bash
|
||||
# 执行下面的命令初始化
|
||||
yarn
|
||||
npm install
|
||||
```
|
||||
|
||||
## 开发环境
|
||||
|
||||
``` bash
|
||||
# 执行下面的命令后即可到 localhost:8010 看到页面
|
||||
# 执行下面的命令后即可到启动前端工程
|
||||
npm run dev
|
||||
```
|
||||
|
||||
## 打包
|
||||
|
||||
``` bash
|
||||
# 开发完成后执行打包命令，然后复制dist目录里的文件到zyplayer-doc-wiki项目的webjars目录下即可
|
||||
# 打包前记得修改zyplayer-doc-ui/wiki-ui/src/common/config/apimix.js里的HOST接口地址
|
||||
npm run build
|
||||
# 开发完成后执行打包命令，然后复制dist目录里的文件到zyplayer-doc-wiki/resources目录下
|
||||
# 复制完成后记得修改index.html为doc-wiki.html
|
||||
# todo：是否可以直接打包为：doc-wiki.html，不用手动改名字
|
||||
# todo：是否可以直接打包到zyplayer-doc-wiki/resources文件夹下，难得复制
|
||||
```
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# zyplayer-doc-wiki
|
||||
|
||||
#### 项目介绍
|
||||
WIKI文档模块，定位为企业内部使用的WIKI文档
|
||||
WIKI文档模块，定位为企业内部使用或个人使用的WIKI文档
|
||||
|
||||
模块的详细使用文档地址，部署必看：
|
||||
|
||||
|
||||
Reference in New Issue
Block a user