zyplayer-doc 正在参加 2021 年度 OSC 中国开源项目评选,请投票支持!
zyplayer-doc 在 2021 年度 OSC 中国开源项目评选 中已获得 {{ projectVoteCount }} 票,请投票支持!
2021 年度 OSC 中国开源项目评选 正在火热进行中,快来投票支持你喜欢的开源项目!
2021 年度 OSC 中国开源项目评选 >>> 中场回顾
zyplayer-doc 获得 2021 年度 OSC 中国开源项目评选「最佳人气项目」 !
授权协议 Apache
开发语言 Java
操作系统 跨平台
软件类型 开源软件
开源组织
地区 国产
投 递 者 暮光城中城
适用人群 未知
收录时间 2019-01-07

软件简介

zyplayer-doc

项目介绍

zyplayer-doc是一款前后端完全开源的在线文档工具,现有API接口文档(Swagger、OpenApi、自建接口)、WIKI文档、数据库文档(数据库表结构查看管理、SQL执行)、Dubbo文档。

体验地址:http://doc.zyplayer.com 账号:zyplayer 密码:123456

各模块的详细使用文档地址,可参考: 详细部署文档

欢迎有想法的一起来完善,如果觉得不错就给个Star鼓励下呗!作为给作者快速更新的动力!

欢迎加群讨论,QQ群号:466363173

快速启动

数据库依赖

你得有一个MySQL数据库,建议版本号为:5.7.25,建库:zyplayer_doc_manage,再执行脚本建表:全量建表语句.sql

main方法启动

  1. 修改 zyplayer-doc/zyplayer-doc-manage/src/main/resources/application.yml 配置文件里面的数据库账号密码
  2. 执行 com.zyplayer.doc.manage.Application.main 方法启动项目,启动后访问:http://127.0.0.1:8083/zyplayer-doc-manage/

jar方式启动

  1. 直接下载:直接下载编译好的jar打包文件,下载地址:https://pan.baidu.com/s/1yMmnle01XR4TDjo2hfvw-Q 提取码: 3adf,下载最新版后解压
  2. 自行编译:也可以自己动手编译,双击执行:zyplayer-doc\build.bat,将使用maven编译整个项目为可执行的jar文件,编译结果文件放在:zyplayer-doc\dist\version 文件夹下,如果电脑没有安装maven则需要先安装
  3. 修改第一步或第二步结果文件夹下的 application.yml 文件里面数据库帐号密码
  4. 双击第一步或第二步结果文件夹下的 startup.bat 启动项目,启动后访问:http://127.0.0.1:8083/zyplayer-doc-manage/

Tomcat容器启动

  1. 直接下载编译好的war打包文件,下载地址:https://pan.baidu.com/s/1yMmnle01XR4TDjo2hfvw-Q 提取码: 3adf,下载最新版后解压
  2. 修改配置文件:zyplayer-doc.zip\apache-tomcat\webapps\zyplayer-doc-manage\WEB-INF\classes\application.yml 配置文件里面的数据库账号密码
  3. 双击tomcat\bin\startup.bat启动即可

默认登录账号:zyplayer 密码:123456

各模块介绍

zyplayer-doc-manage 文档管理后台

  1. 具有项目模块导航,人员及权限管理功能,分组管理等功能。
  2. 集成了本项目内的各个子模块功能,是各模块的协调管理模块。

zyplayer-doc-db 数据库文档

一款在线管理数据库的工具,你可以将所有的数据源统一管理到这里面,团队间的各成员就不必每人在自己电脑上装一个数据库管理软件, 然后再添加数据源,可以统一修改数据库账号密码而不用群广播通知,新员工进入后对他使用到的数据源进行授权即可使用。

  1. 支持MySQL、Doris(MySQL协议)、SQLServer、Oracle、PostgreSQL、Hive、Impala数据源。
  2. 支持数据库表、字段文档查看修改,表文档导出、建表语句DDL导出、表数据导出。
  3. 支持SQL执行、表数据预览、不同数据库之间的数据互导,支持多数据源管理。
  4. 支持按人员、按数据源对用户授权,可给用户 库表注释查看、注释修改、SQL执行、函数修改等粒度的授权。
  5. 支持库函数和存储过程的增删改查,修改记录查询等。
  6. 目标是取代Navicat,做一个小而精的开源免费的在线数据库管理工具。

zyplayer-doc-wiki wiki文档工具

  1. 在线管理公司、项目及任意形式的文档
  2. 文档支持按空间划分,按人员分组授权,支持空间收藏和空间内的文档开放访问。
  3. 文档支持编辑、查看、评论、上传附件、历史版本查看、页面权限控制、文档搜索等功能。
  4. 文档编辑支持html富文本方式编辑和markdown的方式编辑。
  5. 本工具使用的开源工具有:vue、element-ui、mavon-editor、wangeditor等。
  6. 参考学习了Atlassian Confluence文档工具进行开发,争取作为该软件的开源免费替代产品,同时作为内部文档管理工具最好的存在。

zyplayer-doc-api API接口文档管理工具

一款支持统一管理Swagger文档、OpenApi文档、自建接口文档的管理工具,具有文档查看、接口请求、全局参数管理等功能,设计走心,前端代码使用最新技术构建,每一行代码都是全新手动敲出来的,超级简单明了,代码简洁美观可读性好、易维护。

  1. 支持Swagger的文档展示,接口调试,解析速度快,界面设计走心。
  2. 支持将所有的Swagger文档、OpenApi文档、自建接口文档进行统一管理,支持全局参数设置,请求参数缓存,下次自动填充等。
  3. 目标是实现一个平台解决所有项目的接口文档统一管理。

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

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

其他

  1. zyplayer-doc-ui 前面各模块的前端UI源码
  2. zyplayer-doc-core 一些核心、公用的类
  3. zyplayer-doc-data 数据库层面的交互
  4. zyplayer-doc-grpc grpc文档工具
  5. zyplayer-doc-other 一些测试

界面展示

控制台页面

 主页面

数据库文档页面

 数据库文档

WIKI文档页面

 wiki文档

API文档主页面

 主页面

API文档查看页面

 文档查看页面

API文档在线调试页面

 在线调试页面

 

展开阅读全文

代码

的 Gitee 指数为
超过 的项目

评论

点击加入讨论🔥(4)
发表了资讯
2021/12/19 21:30

zyplayer-doc 1.1.0发布,也许你可以尝试一下将所有的 swagger文 档放这里管理

项目介绍 zyplayer-doc是一款前后端完全开源的在线文档工具,现有API接口文档(Swagger、OpenApi、自建接口)、WIKI文档、数据库文档(数据库表结构查看管理、SQL执行)、Dubbo文档。 在线文档:zyplayer-doc使用文档 体验地址:http://doc.zyplayer.com 账号:zyplayer 密码:123456 开源地址:https://gitee.com/zyplayer/zyplayer-doc BUG反馈:https://gitee.com/zyplayer/zyplayer-doc/issues 本次升级内容 本次升级针对数...

0
6
发表了资讯
2021/07/25 16:10

zyplayer-doc 1.0.9 发布,现代化的、集中式的数据库管理工具,WIKI 文档工具

软件介绍 zyplayer-doc是一款定位为公司内部和个人使用的在线工具,现有数据库文档、WIKI文档、swagger 文档、dubbo文档、ElasticSearch文档等,管理端具有人员管理、权限管理功能等功能。项目后端使用spring-boot、mybatis-plus等框架,前端使用Vue、element-ui、zui等框架。 数据库模块 本次升级内容: 1、增加hive和impala数据源支持,可查看表结构、执行SQL查询数据 2、框架优化,数据查询和层级更合理 3、数据查看优化,执...

0
21
发表了资讯
2021/05/01 17:57

zyplayer-doc 1.0.8 发布,简单好用的数据库管理工具、WIKI文档工具

zyplayer-doc是一款定位为公司内部和个人使用的在线工具,现有数据库文档、WIKI文档、swagger 文档、dubbo文档、ElasticSearch文档等,管理端具有人员管理、权限管理功能等功能。项目后端使用spring-boot、mybatis-plus等框架,前端使用Vue、element-ui、zui等框架。 Added 1、控制台支持对用户进行分组管理 2、WIKI文档的空间改为独立页面管理,支持对分组进行授权 3、WIKI文档的空间支持收藏,可只展示收藏的空间 4、WIKI文档...

0
19
发表于大前端专区
2021/05/01 17:48

zyplayer-doc v1.0.8 已经发布,通用文档管理工具

zyplayer-doc v1.0.8 已经发布,通用文档管理工具 此版本更新内容包括: zyplayer-doc是一款定位为公司内部和个人使用的在线工具,现有数据库文档、WIKI文档、swagger 文档、dubbo文档、ElasticSearch文档等,管理端具有人员管理、权限管理功能等功能。项目后端使用spring-boot、mybatis-plus等框架,前端使用Vue、element-ui、zui等框架。 Added 1、控制台支持对用户进行分组管理 2、WIKI文档的空间改为独立页面管理,支持对分...

0
0
2021/01/01 20:00

zyplayer-doc 1.0.7 发布,简单好用的 WIKI 文档工具、数据库管理工具

zyplayer-doc是一款定位为公司内部和个人使用的在线工具,现有数据库文档、WIKI文档、swagger 文档、dubbo文档、ElasticSearch文档等,管理端具有人员管理、权限管理功能等功能。项目后端使用spring-boot、mybatis-plus等框架,前端使用Vue、element-ui、zui等框架。 Added 1、WIKI文档工具增加历史版本功能,原创使用git方式管理wiki历史版本和查看,并且支持push到远程仓库 2、WIKI文档工具修改Markdown格式的历史版本显示问题...

2
25
发表于运维专区
2020/08/23 14:22

zyplayer-doc 1.0.6 发布,简单好用的 WIKI 文档工具、数据库管理工具

zyplayer-doc是一款定位为公司内部和个人使用的在线工具,现有数据库文档、WIKI文档、swagger 文档、dubbo文档、ElasticSearch文档等,管理端具有人员管理、权限管理功能等功能。项目后端使用spring-boot、mybatis-plus等框架,前端使用Vue、element-ui、zui等框架。 Added 1、数据库工具增加数据源时支持测试数据源,优化展示细节,特殊情况下页面卡死等问题 2、数据库工具改为使用vue-cli打包,修改所有的请求方式,代码更加规...

0
9
2020/05/16 11:01

zyplayer-doc 1.0.5 发布,小目标是在线化的 Navicat 数据库管理工具

zyplayer-doc是一款在线文档工具,现有swagger 文档、dubbo文档、数据库文档、WIKI文档、ElasticSearch文档等,管理端具有人员管理、权限管理功能等功能。项目后端使用spring-boot、mybatis-plus等框架,前端使用zui、Vue、element-ui等框架。 Added 1、swagger文档支持禁用和启用,默认值及展示优化 #群需求 2、数据库文档增加oracle支持#群友提供#,去掉jta事务管理 #I1DU2K 3、新增数据互导功能,可支持不同库表间的数据互导...

4
17
2019/09/10 22:57

zyplayer-doc 1.0.4 发布,统一的 DB 数据源管理和 SQL 执行器

本次升级内容: 1、swagger文档支持给文档地址重命名,下拉时方便查看 2、swagger文档去掉“文档地址管理”页管理,统一改为“详细地址管理” 3、数据库文档增加权限控制,分为:库表查看权,注释修改权,SQL执行权 4、数据库文档增加SQL执行器,可直接执行SQL 4.1、支持库、表、字段的智能提示 4.2、支持SQL收藏和历史记录查看 4.3、支持多SQL执行,执行时长和影响条数展示,支持选中执行、快捷键执行等 5、数据库文档表信息增...

0
25
2019/08/17 21:43

zyplayer-doc 1.0.3 发布,现代化的文档管理系统

本次升级内容: 1、swagger的大面积细节优化 2、swagger支持json文档录入,相当于离线文档,可以不通过接口实时获取了--来自群里的需求 3、数据库文档重构,界面更加美观大方,使用左侧树形菜单方式 4、数据库表支持导出,离线查看 5、增加ES模块,支持ElasticSearch的文档查看和执行DSL查询的功能(暂时我只需要这两个功能~有需求欢迎提交) 6、用户管理优化,支持修改密码--来自群里的需求 7、wiki支持使用ElasticSearch进行存...

0
33
2019/06/30 16:18

zyplayer-doc 1.0.2 发布,定位为企业内部的文档管理系统

zyplayer-doc简介: 定位为企业内部的文档管理系统,具有自主开发的 swagger、数据库、dubbo、wiki、grpc文档模块的文档工具 本次主要升级内容: 1、移除spring security,重构权限和登录逻辑 2、wiki文档页面增加权限控制,分为文章删除、上传附件删除附件、文章修改、权限管理 3、使用vue重构wiki前端,使得页面分离更好维护 4、wiki文档增加阅读数 5、wiki文档支持拖动改变文章顺序 6、wiki删除时使用递归删除子页面 7、wik...

0
32
2019/04/21 19:22

zyplayer-doc 1.0.1 发布,你家所需的文档管理工具他都承包了!

体验地址:http://doc.zyplayer.com/zyplayer-doc-manage/static/manage/home.html 账号:zyplayer 密码:123456 使用文档地址:http://doc.zyplayer.com/zyplayer-doc-manage/open-wiki.html?space=23f3f59a60824d21af9f7c3bbc9bc3cb 无需登录 本次升级内容: 1、增加zyplayer-doc-wiki模块 支持空间隔离 支持附件上传 拖动可以改变wiki顺序 基本的文档创建、编辑、评论、删除、搜索等功能 2、增加zyplayer-doc-grpc模块 用比较...

3
51
2019/02/15 22:13

zyplayer-doc 1.0.0 发布,统一的开发文档管理工具

V1.0.0 功能: 1、zyplayer-doc-swagger,swagger接口文档展示方案,在之前的项目中有许多改进,坚持文档生成和展示分离,有较多需要服务端支持的功能,不对各项目做过多的入侵即可使用,可动态对文档进行开放访问 2、zyplayer-doc-dubbo,支持对dubbo服务的自动扫描,直观展示所有的服务,文档的展示、文档编辑和在线接口调试,不需要对已有的服务做任何改动,支持zookeeper、nacos注册中心的服务扫描 3、zyplayer-doc-db,数据...

0
32
没有更多内容
加载失败,请刷新页面
点击加载更多
加载中
下一页
发表了博客
{{o.pubDate | formatDate}}

{{formatAllHtml(o.title)}}

{{parseInt(o.replyCount) | bigNumberTransform}}
{{parseInt(o.viewCount) | bigNumberTransform}}
没有更多内容
暂无内容
发表了问答
{{o.pubDate | formatDate}}

{{formatAllHtml(o.title)}}

{{parseInt(o.replyCount) | bigNumberTransform}}
{{parseInt(o.viewCount) | bigNumberTransform}}
没有更多内容
暂无内容
4 评论
157 收藏
分享
OSCHINA
登录后可查看更多优质内容
返回顶部
顶部
返回顶部
顶部