|
|
|
|
@ -1,41 +1,84 @@
|
|
|
|
|
# zyplayer-doc
|
|
|
|
|
|
|
|
|
|
#### 项目介绍
|
|
|
|
|
定位为所有文档的管理项目，swagger文档、数据库文档、、、、等，提供一整套的解决方案，欢迎有想法的一起来写
|
|
|
|
|
定位为所有文档的管理项目，swagger文档、数据库文档....等，提供一整套的解决方案，欢迎有想法的一起来写
|
|
|
|
|
|
|
|
|
|
#### 软件架构
|
|
|
|
|
##### zyplayer-doc-core 一些核心、公用的类
|
|
|
|
|
##### 一、zyplayer-doc-core 一些核心、公用的类
|
|
|
|
|
|
|
|
|
|
##### zyplayer-doc-db 数据库文档
|
|
|
|
|
##### 二、zyplayer-doc-db 数据库文档
|
|
|
|
|
> 原[zyplayer-doc-db](https://gitee.com/zyplayer/zyplayer-doc-db)，具有数据库文档的查看、管理、导出等功能
|
|
|
|
|
|
|
|
|
|
##### zyplayer-doc-manage 可以单独部署的文档管理后台
|
|
|
|
|
> 后端使用spring-boot、mybatis-plus、springfox-swagger等优秀框架，前端使用[ZUI](http://zui.sexy/)、[Vue](https://cn.vuejs.org/)等框架
|
|
|
|
|
##### 三、zyplayer-doc-manage 可以单独部署的文档管理后台
|
|
|
|
|
> 后端使用spring-boot、mybatis-plus、springfox-swagger等框架，前端使用[zui](http://zui.sexy/)、[Vue](https://cn.vuejs.org/)等框架
|
|
|
|
|
|
|
|
|
|
> 已集成三套优秀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-db](https://gitee.com/zyplayer/zyplayer-doc)数据库文档
|
|
|
|
|
|
|
|
|
|
##### 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
|
|
|
|
|
|
|
|
|
|
#### 打开方式
|
|
|
|
|
#### 运行方式
|
|
|
|
|
|
|
|
|
|
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)
|
|
|
|
|
|
|
|
|
|
2. 修改zyplayer-doc-manage项目的application.yml配置文件里面的数据库账号密码
|
|
|
|
|
|
|
|
|
|
3. 启动zyplayer-doc-manage项目
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
3. 启动zyplayer-doc-manage项目，访问地址：
|
|
|
|
|
http://127.0.0.1:8082/zyplayer-doc-manage/statics/manage/home.html
|
|
|
|
|
|
|
|
|
|
#### 功能介绍
|
|
|
|
|
|
|
|
|
|
##### 一、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)
|
|
|
|
|
|
|
|
|
|
完成，就可以看到提供的三套UI地址和一个后台管理地址，默认集成了三套优秀的swagger的UI提供选择
|
|
|
|
|
7. 后端代理请求，后端存储，不会存在任何跨域问题
|
|
|
|
|
|
|
|
|
|
进入：http://127.0.0.1:8082/zyplayer-doc-manage/document.html 管理和增加任意地址的文档，在集成的三套UI中都可以直接查看和调试这里配置的文档，不用对UI做任何调整，只要标准的UI集成进来也可以直接用
|
|
|
|
|
|
|
|
|
|
##### 二、zyplayer-doc-db
|
|
|
|
|
1. 支持Mysql、SQLserver的数据库表、字段文档查看修改，导出，展示关系图等功能
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2. 支持多数据源，在`zyplayer-doc-manage` -> `application.yml` -> `zyplayer.doc.db.dbConfigList` 处配置多个数据库连接即可
|
|
|
|
|
|
|
|
|
|
#### 权限和人员管理
|
|
|
|
|
进入后台管理地址可对人员、权限进行配置：http://127.0.0.1:8082/zyplayer-doc-manage/statics/manage/home.html 所有的文档都必须登录之后且具有权限才可访问
|
|
|
|
|
##### 三、zyplayer-doc-manage
|
|
|
|
|
1. 整合了上面两个功能到此项目，较少熟悉成本，`git clone`下来即可运行
|
|
|
|
|
|
|
|
|
|
2. 具有简单的`权限管理`、`人员管理`功能（还没想好具体怎么控制，没需求）
|
|
|
|
|
|
|
|
|
|
3. 使用最新的一些技术框架，很简单，初学者拿来学习也是很不错的
|
|
|
|
|
|
|
|
|
|
#### 界面展示
|
|
|
|
|
权限和用户管理：
|
|
|
|
|
|
|
|
|
|
数据库文档：
|
|
|
|
|
|
|
|
|
|
增加文档处：
|
|
|
|
|
|
|
|
|
|
使用springfox-swagger-ui访问增加的文档：
|
|
|
|
|
|
|
|
|
|
文档展示：
|
|
|
|
|
|
|
|
|
|
在线调试：
|
|
|
|
|
|
|
|
|
|
模拟返回：
|
|
|
|
|
|
|
|
|
|
文档配置：
|
|
|
|
|
|
|
|
|
|
全局参数管理：
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
暮光：城中城
6 years ago