zyplayer-doc 通用文档管理工具 项目简介
zyplayer-doc项目介绍定位为所有文档的管理项目,swagger文档、数据库文档....等,提供一整套的解决方案,欢迎有想法的一起来写软件架构一、zyplayer-doc-core 一些核心、公用的类二、zyplayer-doc-db 数据库文档原zyplayer-doc-db,具有数据库文档的查看、管理、导出等功能三、zyplayer-doc-manage 可以单独部署的文档管理后台后端使用spring-boot、mybatis-plus、springfox-swagger等框架,前端使用zui、Vue等框架已集成三套优秀swagger文档前端:zyplayer-doc-swagger、swagger-bootstrap-ui、springfox-swagger-ui已集成zyplayer-doc-db数据库文档四、zyplayer-doc-swagger 原swagger-mg-ui,swagger的UI及整套解决方案具有 后端存储、代理请求、模拟返回、所有文档管理 等一系列原创功能,不止UI运行方式创建数据库:zyplayer_doc_manage,执行脚本:zyplayer_doc_manage.sql修改zyplayer-doc-manage项目的application.yml配置文件里面的数据库账号密码启动zyplayer-doc-manage项目,访问地址: http://127.0.0.1:8082/zyplayer-doc-manage/statics/manage/home.html功能介绍一、zyplayer-doc-swagger在 zyplayer-doc-swagger->文档管理->文档地址管理 页可以管理任意地址的文档,在集成的三套UI中都可以直接查看和调试这里配置的文档,不用对UI做任何调整,只要标准的UI集成进来也可以直接用文档展示配置,自动填充请求参数:可配置填充级别,强制重写域名:文档在本地想调试线上接口的好帮手,自动保存请求参数:不用每次输入可配置全局参数,放在header或param里的可对调试数据进行管理模拟返回:前端自行调试接口的好帮手私人强迫症级定制化文档展示,清晰明了,参数支持批量编辑,每一条线的间距都考量了半天,支持文件上传的调试,需要指定dataType = File或MultipartFile,例:@ApiImplicitParam(name = "file", value = "文件", dataType = "File", allowMultiple = true)后端代理请求,后端存储,不会存在任何跨域问题二、zyplayer-doc-db支持Mysql、SQLserver的数据库表、字段文档查看修改,导出,展示关系图等功能支持多数据源,在zyplayer-doc-manage -> application.yml -> zyplayer.doc.db.dbConfigList 处配置多个数据库连接即可三、zyplayer-doc-manage整合了上面两个功能到此项目,较少熟悉成本,git clone下来即可运行具有简单的权限管理、人员管理功能(还没想好具体怎么控制,没需求)使用最新的一些技术框架,很简单,初学者拿来学习也是很不错的界面展示权限和用户管理: 数据库文档: 增加文档处: 使用springfox-swagger-ui访问增加的文档: 文档展示: 在线调试: 模拟返回: 文档配置: 全局参数管理: