zyplayer-doc是一款前后端完全開源的在線文檔工具，現(xiàn)有API接口文檔(Swagger、OpenApi、自建接口)、WIKI文檔、數(shù)據(jù)庫文檔(數(shù)據(jù)庫表結構查看管理、SQL執(zhí)行)。

快速啟動

數(shù)據(jù)庫依賴

你得有一個MySQL數(shù)據(jù)庫，建議版本號為：5.7.25，建庫：zyplayer_doc_manage，再執(zhí)行腳本建表：全量建表語句.sql

main方法啟動

1、修改 zyplayer-doc/zyplayer-doc-manage/src/main/resources/application.yml 配置文件里面的數(shù)據(jù)庫賬號密碼

2、執(zhí)行 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、自行編譯：也可以自己動手編譯，雙擊執(zhí)行：zyplayer-doc\build.bat，將使用maven編譯整個項目為可執(zhí)行的jar文件，編譯結果文件放在：zyplayer-doc\dist\version 文件夾下，如果電腦沒有安裝maven則需要先安裝

3、修改第一步或第二步結果文件夾下的 application.yml 文件里面數(shù)據(jù)庫帳號密碼

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 配置文件里面的數(shù)據(jù)庫賬號密碼

3、雙擊tomcat\bin\startup.bat啟動即可

默認登錄賬號：zyplayer 密碼：123456

各模塊介紹

zyplayer-doc-manage 文檔管理后臺

1、具有項目模塊導航，人員及權限管理功能，分組管理等功能。

2、集成了本項目內(nèi)的各個子模塊功能，是各模塊的協(xié)調(diào)管理模塊。

zyplayer-doc-db 數(shù)據(jù)庫文檔

一款在線管理數(shù)據(jù)庫的工具，你可以將所有的數(shù)據(jù)源統(tǒng)一管理到這里面，團隊間的各成員就不必每人在自己電腦上裝一個數(shù)據(jù)庫管理軟件， 然后再添加數(shù)據(jù)源，可以統(tǒng)一修改數(shù)據(jù)庫賬號密碼而不用群廣播通知，新員工進入后對他使用到的數(shù)據(jù)源進行授權即可使用。

1、支持MySQL、Doris(MySQL協(xié)議)、SQLServer、Oracle、PostgreSQL、Hive、Impala數(shù)據(jù)源。

2、支持數(shù)據(jù)庫表、字段文檔查看修改，表文檔導出、建表語句DDL導出、表數(shù)據(jù)導出。

3、支持SQL執(zhí)行、表數(shù)據(jù)預覽、不同數(shù)據(jù)庫之間的數(shù)據(jù)互導，支持多數(shù)據(jù)源管理。

4、支持按人員、按數(shù)據(jù)源對用戶授權，可給用戶 庫表注釋查看、注釋修改、SQL執(zhí)行、函數(shù)修改等粒度的授權。

5、支持庫函數(shù)和存儲過程的增刪改查，修改記錄查詢等。

6、目標是取代Navicat，做一個小而精的開源免費的在線數(shù)據(jù)庫管理工具。

zyplayer-doc-wiki wiki文檔工具

1、在線管理公司、項目及任意形式的文檔

2、文檔支持按空間劃分，按人員分組授權，支持空間收藏和空間內(nèi)的文檔開放訪問。

3、文檔支持編輯、查看、評論、上傳附件、歷史版本查看、頁面權限控制、文檔搜索等功能。

4、文檔編輯支持html富文本方式編輯和markdown的方式編輯。

5、本工具使用的開源工具有：vue、element-ui、mavon-editor、wangeditor等。

6、參考學習了Atlassian Confluence文檔工具進行開發(fā)，爭取作為該軟件的開源免費替代產(chǎn)品，同時作為內(nèi)部文檔管理工具最好的存在。

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

一款支持統(tǒng)一管理Swagger文檔、OpenApi文檔、自建接口文檔的管理工具，具有文檔查看、接口請求、全局參數(shù)管理等功能，設計走心，前端代碼使用最新技術構建，每一行代碼都是全新手動敲出來的，超級簡單明了，代碼簡潔美觀可讀性好、易維護。

1、支持Swagger的文檔展示，接口調(diào)試，解析速度快，界面設計走心。

2、支持將所有的Swagger文檔、OpenApi文檔、自建接口文檔進行統(tǒng)一管理，支持全局參數(shù)設置，請求參數(shù)緩存，下次自動填充等。

3、目標是實現(xiàn)一個平臺解決所有項目的接口文檔統(tǒng)一管理。

其他

1、zyplayer-doc-ui 前面各模塊的前端UI源碼

2、zyplayer-doc-core 一些核心、公用的類

3、zyplayer-doc-data 數(shù)據(jù)庫層面的交互

4、zyplayer-doc-other 一些測試

v1.1.6更新內(nèi)容

新增功能

文檔管理頁面優(yōu)化，更簡潔和現(xiàn)代化

新增模板管理功能

新增文檔移動和復制功能

修改頁面新建和附件保存邏輯

增加達夢數(shù)據(jù)庫支持

db模塊tab頁面增加右鍵菜單

sql執(zhí)行器增加上下布局拖拽

功能優(yōu)化

Word文檔導出優(yōu)化

添加rewriteBatchedStatements=true提高批量操作數(shù)據(jù)庫效率

db模塊全局滾動條美化

sql執(zhí)行器頁面易用性優(yōu)化

db模塊增加節(jié)流、防抖函數(shù)，有效提升頁面性能

修改模塊化加載，可以通過配置文件控制加載哪些模塊，同時前端有對應顯示

其他各種細節(jié)優(yōu)化

問題修復

#I85QPE:文件里面的圖片也被當成附件了，看文檔很影響體驗！ 處理附件列表問題，優(yōu)化文件上傳邏輯

修改數(shù)據(jù)互導查詢總條數(shù)時某些數(shù)據(jù)庫將別名大寫了的問題

修復oracle數(shù)據(jù)庫字段大小混寫導致表數(shù)據(jù)結果頁面報錯問題