1 Star 0 Fork 170

八块腹肌的阿明 / zyplayer-doc

Create your Gitee Account
Explore and code with more than 6 million developers,Free private repositories !:)
Sign up
Clone or download
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
README.md

zyplayer-doc

项目介绍

定位为所有文档的管理项目,swagger文档、dubbo文档、数据库文档、wiki、ElasticSearch文档....等,提供一整套的解决方案,为开发者服务,欢迎有想法的一起来写,给个Star鼓励下呗!(您的一个Star是快速迭代的动力源泉!) 欢迎加群讨论,QQ群号:466363173

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

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

软件架构

一、zyplayer-doc-core 一些核心、公用的类
二、zyplayer-doc-db 数据库文档

zyplayer-doc-db,具有数据库文档的查看、管理、导出等功能

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

后端使用spring-boot、mybatis-plus、springfox-swagger等框架,前端使用zuiVueelement-ui等框架

已集成三套优秀swagger文档前端:zyplayer-doc-swaggerswagger-bootstrap-uispringfox-swagger-ui

已集成本项目内的各子模块,可直接使用

四、zyplayer-doc-swagger 原swagger-mg-ui,swagger的UI及整套解决方案

具有 后端存储、代理请求、模拟返回、所有文档管理 等一系列原创功能,不止UI

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

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

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

支持文档创建、展示,文件上传、下载,空间隔离,开放文档访问等

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

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

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

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

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

运行方式

  1. 创建数据库:zyplayer_doc_manage,执行脚本:zyplayer_doc_manage.1.0.4.sql

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

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

模块介绍

一、zyplayer-doc-swagger
  1. zyplayer-doc-swagger->文档管理->文档地址管理 页可以管理任意地址的文档,在集成的三套UI中都可以直接查看和调试这里配置的文档,不用对UI做任何调整,只要标准的UI集成进来也可以直接用

  2. 文档展示配置,自动填充请求参数:可配置填充级别,强制重写域名:文档在本地想调试线上接口的好帮手,自动保存请求参数:不用每次输入

  3. 可配置全局参数,放在header或param里的

  4. 可对调试数据进行管理

  5. 模拟返回:前端自行调试接口的好帮手

  6. 私人强迫症级定制化文档展示,清晰明了,参数支持批量编辑,每一条线的间距都考量了半天,支持文件上传的调试,需要指定dataType = FileMultipartFile,例:

@ApiImplicitParam(name = "file", value = "文件", dataType = "File", allowMultiple = true)

  1. 后端代理请求,后端存储,不会存在任何跨域问题
二、zyplayer-doc-db
  1. 支持Mysql、SQLserver的数据库表、字段文档查看修改,导出,展示关系图等功能

  2. 支持多数据源,在zyplayer-doc-manage -> application.yml -> zyplayer.doc.db.dbConfigList 处配置多个数据库连接即可

三、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的配置

  4. 支持文档查找、文档编辑、在线调试接口

  5. 自动获取参数列表需要指定的类存在,所以请在 pom.xml -> dependencies 最后加上服务所在的包,后端才能通过Class.forName("xx");来找到参数列表,减少录入成本

  6. 数组或List参数,调试参数录入格式例:[1,2] ,后端通过JSON工具转成指定类型,有不支持的类型时欢迎反馈

四、zyplayer-doc-manage
  1. 整合了上面两个功能到此项目,较少熟悉成本,git clone下来即可运行

  2. 具有简单的权限管理人员管理功能

  3. 使用最新的一些技术框架,很简单,初学者拿来学习也是很不错的

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

Comments ( 0 )

Sign in for post a comment

About

定位为所有文档的管理项目,swagger文档、dubbo文档、wiki文档、grpc文档、数据库文档、elasticsearch文档...等,提供一整套的解决方案,基础功能已比较完善,欢迎使用和加入开发 spread retract
Java
Apache-2.0
Cancel

Releases

No release

Contributors

All

Activities

load more
can not load any more
Java
1
https://gitee.com/yuebanriyue/zyplayer-doc.git
git@gitee.com:yuebanriyue/zyplayer-doc.git
yuebanriyue
zyplayer-doc
zyplayer-doc
master

Search

103611 48b8ff67 1899542 103622 4d02230c 1899542