2021-01-23 13:30:27 +08:00
2021-01-01 19:31:08 +08:00
2021-01-16 16:05:50 +08:00
2021-01-01 19:31:08 +08:00
2021-01-01 19:31:08 +08:00
2021-01-01 19:31:08 +08:00
2021-01-01 19:31:08 +08:00
2021-01-01 19:31:08 +08:00
2018-11-27 21:56:06 +08:00
2021-01-01 19:31:08 +08:00
2021-01-01 19:31:08 +08:00
2021-01-01 21:54:08 +08:00

zyplayer-doc

项目介绍

zyplayer-doc是一款在线文档工具现有swagger 文档、dubbo文档、数据库文档、WIKI文档、ElasticSearch文档等管理端具有人员管理、权限管理功能等功能。项目后端使用spring-boot、mybatis-plus等框架前端使用zui、Vue、element-ui等框架。为开发者服务欢迎有想法的一起来写给个Star鼓励下呗您的一个Star是快速迭代的动力源泉 欢迎加群讨论QQ群号466363173

体验地址:http://doc.zyplayer.com 需登录 账号zyplayer 密码123456 未运行dubbo服务不能体验dubbo文档调试

各模块的详细使用文档地址,部署必看: http://doc.zyplayer.com/zyplayer-doc-manage/doc-wiki#/page/share/view?pageId=1&space=23f3f59a60824d21af9f7c3bbc9bc3cb

模块介绍

一、zyplayer-doc-core

一些核心、公用的类

二、zyplayer-doc-manage 可以单独部署的文档管理后台

集成了本项目内的各子模块,具有人员及权限管理功能,是各模块的协调模块

三、zyplayer-doc-db 数据库文档

支持MySQL、SQLServer、Oracle数据源支持数据库表、字段文档查看修改表文档导出SQL执行、表数据预览、不同数据库之间的数据互导支持多数据源管理。支持按人员、按数据源对用户授权可给用户 库表注释查看、注释修改、SQL执行 粒度的授权。目标是取代Navicat做一个开源免费的在线数据库管理工具。

四、zyplayer-doc-wiki wiki文档工具

在线管理公司、项目及任意形式的文档文档支持按空间划分在线编辑查看支持附件上传下载支持评论、点赞及权限设置等。参考学习了Atlassian Confluence文档工具进行开发争取作为该软件的开源免费替代产品同时作为内部文档管理工具最好的存在。

五、zyplayer-doc-swaggerswagger的UI及整套解决方案

支持swagger的文档展示接口调试文档导出等解析速度快界面设计走心。支持将所有的swagger文档进行统一管理支持全局参数设置请求参数缓存下次自动填充等。目标是解决swagger官方文档查看及接口调试不方便的问题。

六、zyplayer-doc-dubbo 将dubbo的文档在线化管理

支持zookeeper、nacos的注册中心文档获取支持在线调试接口

七、zyplayer-doc-grpc grpc文档工具

用比较变态的方式实现了grpc的文档和在线调试功能通过http的方式来请求grpc的接口

默认未开启此功能如需使用需要在zyplayer-doc-manage项目中开启@EnableDocGrpc注解

八、zyplayer-doc-es ElasticSearch文档工具

支持ElasticSearch的文档查看和执行DSL查询的功能

九、zyplayer-doc-ui

前面各模块的前端UI源码

运行方式

  1. 创建数据库zyplayer_doc_manage执行脚本zyplayer_doc_manage.1.0.7.sql

  2. 修改zyplayer-doc-manage项目的application.yml配置文件里面的数据库账号密码

  3. 启动zyplayer-doc-manage项目访问地址http://127.0.0.1:8083/zyplayer-doc-manage/

更多详细的使用部署文档:http://doc.zyplayer.com/zyplayer-doc-manage/doc-wiki#/page/share/view?pageId=1&space=23f3f59a60824d21af9f7c3bbc9bc3cb

虽然在GitHub上也有账号虽然本项目也不是很好但还是内在自发的只在码云上活跃每个人的一次活跃、一次评论、一次PR、一次Issue、一次鼓励的捐赠都能聚集起来聚沙成塔营造一个每个人都希望看到的一个开源文化和氛围引用码云推文的一段话

不再习惯性地把国内开源生态的落后归咎于开源文化和氛围,我们应意识到每人都是开源生态中的一员,我们拥有实际行动的力量,良好的开源文化和氛围需要大家的共同努力。

不再把开源当作「别人的事」、「大佬们的事」,尽己所能地参与建设,哪怕是一个 Issue、一个 PR健康的开源生态就是由这一个个反馈、一次次协作构建起来的。

界面展示

主页面 数据库文档 wiki文档

Description
No description provided
Readme Apache-2.0 73 MiB
Languages
Java 51.6%
Vue 43.2%
JavaScript 3.6%
SCSS 1.2%
HTML 0.2%
Other 0.1%