zyplayer-doc

項目介紹

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

體驗地址：http://doc.zyplayer.com 賬號：zyplayer 密碼：123456

各模塊的詳細使用文檔地址，可參考：詳細部署文檔

歡迎有想法的一起來完善，如果覺得不錯就給個Star鼓勵下唄！作為給作者快速更新的動力！

歡迎加群討論，QQ群號：466363173

快速啟動

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

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

main方法啟動

修改 zyplayer-doc/zyplayer-doc-manage/src/main/resources/application.yml 配置文件里面的數(shù)據(jù)庫賬號密碼
執(zhí)行 com.zyplayer.doc.manage.Application.main 方法啟動項目，啟動后訪問：http://127.0.0.1:8083/zyplayer-doc-manage/

jar方式啟動

直接下載：直接下載編譯好的jar打包文件，下載地址：https://pan.baidu.com/s/1yMmnle01XR4TDjo2hfvw-Q 提取碼: 3adf，下載最新版后解壓
自行編譯：也可以自己動手編譯，雙擊執(zhí)行：zyplayer-doc\build.bat，將使用maven編譯整個項目為可執(zhí)行的jar文件，編譯結(jié)果文件放在：zyplayer-doc\dist\version 文件夾下，如果電腦沒有安裝maven則需要先安裝
修改第一步或第二步結(jié)果文件夾下的 application.yml 文件里面數(shù)據(jù)庫帳號密碼
雙擊第一步或第二步結(jié)果文件夾下的 startup.bat 啟動項目，啟動后訪問：http://127.0.0.1:8083/zyplayer-doc-manage/

Tomcat容器啟動

直接下載編譯好的war打包文件，下載地址：https://pan.baidu.com/s/1yMmnle01XR4TDjo2hfvw-Q 提取碼: 3adf，下載最新版后解壓
修改配置文件：zyplayer-doc.zip\apache-tomcat\webapps\zyplayer-doc-manage\WEB-INF\classes\application.yml 配置文件里面的數(shù)據(jù)庫賬號密碼
雙擊tomcat\bin\startup.bat啟動即可

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

各模塊介紹

zyplayer-doc-manage 文檔管理后臺

具有項目模塊導(dǎo)航，人員及權(quán)限管理功能，分組管理等功能。
集成了本項目內(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ù)源進行授權(quán)即可使用。

支持MySQL、Doris（MySQL協(xié)議）、SQLServer、Oracle、PostgreSQL、Hive、Impala數(shù)據(jù)源。
支持?jǐn)?shù)據(jù)庫表、字段文檔查看修改，表文檔導(dǎo)出、建表語句DDL導(dǎo)出、表數(shù)據(jù)導(dǎo)出。
支持SQL執(zhí)行、表數(shù)據(jù)預(yù)覽、不同數(shù)據(jù)庫之間的數(shù)據(jù)互導(dǎo)，支持多數(shù)據(jù)源管理。
支持按人員、按數(shù)據(jù)源對用戶授權(quán)，可給用戶庫表注釋查看、注釋修改、SQL執(zhí)行、函數(shù)修改等粒度的授權(quán)。
支持庫函數(shù)和存儲過程的增刪改查，修改記錄查詢等。
目標(biāo)是取代Navicat，做一個小而精的開源免費的在線數(shù)據(jù)庫管理工具。

zyplayer-doc-wiki wiki文檔工具

在線管理公司、項目及任意形式的文檔
文檔支持按空間劃分，按人員分組授權(quán)，支持空間收藏和空間內(nèi)的文檔開放訪問。
文檔支持編輯、查看、評論、上傳附件、歷史版本查看、頁面權(quán)限控制、文檔搜索等功能。
文檔編輯支持html富文本方式編輯和markdown的方式編輯。
本工具使用的開源工具有：vue、element-ui、mavon-editor、wangeditor等。
參考學(xué)習(xí)了Atlassian Confluence文檔工具進行開發(fā)，爭取作為該軟件的開源免費替代產(chǎn)品，同時作為內(nèi)部文檔管理工具最好的存在。

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

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

支持Swagger的文檔展示，接口調(diào)試，解析速度快，界面設(shè)計走心。
支持將所有的Swagger文檔、OpenApi文檔、自建接口文檔進行統(tǒng)一管理，支持全局參數(shù)設(shè)置，請求參數(shù)緩存，下次自動填充等。
目標(biāo)是實現(xiàn)一個平臺解決所有項目的接口文檔統(tǒng)一管理。