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

快速啟動(dòng)

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

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

main方法啟動(dòng)

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

2、執(zhí)行 com.zyplayer.doc.manage.Application.main 方法啟動(dòng)項(xiàng)目，啟動(dòng)后訪問：http://127.0.0.1:8083/zyplayer-doc-manage/

jar方式啟動(dòng)

1、直接下載：直接下載編譯好的jar打包文件，下載地址：https://pan.baidu.com/s/1yMmnle01XR4TDjo2hfvw-Q 提取碼: 3adf，下載最新版后解壓

2、自行編譯：也可以自己動(dòng)手編譯，雙擊執(zhí)行：zyplayer-doc\build.bat，將使用maven編譯整個(gè)項(xiàng)目為可執(zhí)行的jar文件，編譯結(jié)果文件放在：zyplayer-doc\dist\version 文件夾下，如果電腦沒有安裝maven則需要先安裝

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

4、雙擊第一步或第二步結(jié)果文件夾下的 startup.bat 啟動(dòng)項(xiàng)目，啟動(dòng)后訪問：http://127.0.0.1:8083/zyplayer-doc-manage/

Tomcat容器啟動(dòng)

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ù)庫(kù)賬號(hào)密碼

3、雙擊tomcat\bin\startup.bat啟動(dòng)即可

默認(rèn)登錄賬號(hào)：zyplayer 密碼：123456

各模塊介紹

zyplayer-doc-manage 文檔管理后臺(tái)

1、具有項(xiàng)目模塊導(dǎo)航，人員及權(quán)限管理功能，分組管理等功能。

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

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

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

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

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

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

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

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

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

zyplayer-doc-wiki wiki文檔工具

1、在線管理公司、項(xiàng)目及任意形式的文檔

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

3、文檔支持編輯、查看、評(píng)論、上傳附件、歷史版本查看、頁(yè)面權(quán)限控制、文檔搜索等功能。

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

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

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

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

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

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

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

3、目標(biāo)是實(shí)現(xiàn)一個(gè)平臺(tái)解決所有項(xiàng)目的接口文檔統(tǒng)一管理。

其他

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

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

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

4、zyplayer-doc-other 一些測(cè)試

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

新增功能

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

新增模板管理功能

新增文檔移動(dòng)和復(fù)制功能

修改頁(yè)面新建和附件保存邏輯

增加達(dá)夢(mèng)數(shù)據(jù)庫(kù)支持

db模塊tab頁(yè)面增加右鍵菜單

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

功能優(yōu)化

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

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

db模塊全局滾動(dòng)條美化

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

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

修改模塊化加載，可以通過配置文件控制加載哪些模塊，同時(shí)前端有對(duì)應(yīng)顯示

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

問題修復(fù)

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

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

修復(fù)oracle數(shù)據(jù)庫(kù)字段大小混寫導(dǎo)致表數(shù)據(jù)結(jié)果頁(yè)面報(bào)錯(cuò)問題