1. Project Overview

zyplayer-doc is a fully open-source online documentation tool with both frontend and backend code available. It provides API documentation (Swagger, OpenAPI, and custom APIs), WIKI documentation, and database documentation (database table structure browsing and management, SQL execution).

2. Open Source License

Licensed under Apache-2.0

3. Screenshots

Console Page

Database Documentation Page

WIKI Documentation Page

Main API Documentation Page

API Documentation Viewing Page

Online API Documentation Debugging Page

4. Feature Overview

Module Overview

zyplayer-doc-manage Documentation Management Backend

1. Features include project module navigation, user and permission management, group management, and more.
2. Integrates the functions of all submodules in this project and serves as the coordination and management module for each module.

zyplayer-doc-db Database Documentation

An online database management tool that allows you to centrally manage all your data sources. Team members no longer need to install database management software on their own computers and add data sources individually. Database account passwords can be updated centrally without having to notify everyone through group broadcasts. New employees can simply be granted access to the data sources they need and start using them immediately.

1. Supports MySQL, Doris (MySQL protocol), SQL Server, Oracle, PostgreSQL, Hive, and Impala data sources.
2. Supports viewing and editing database table and field documentation, exporting table documentation, exporting table creation statements (DDL), and exporting table data.
3. Supports SQL execution, table data previews, data migration between different databases, and multi-source management.
4. Supports user authorization by personnel and data source, with granular permissions for viewing and modifying database and table comments, executing SQL, modifying functions, and more.
5. Supports creating, reading, updating, and deleting database functions and stored procedures, as well as querying modification history.
6. The goal is to replace Navicat with a compact, polished, open-source, free online database management tool.

zyplayer-doc-wiki WIKI Documentation Tool

1. Online management of company, project, and other types of documentation.
2. Documents can be organized by workspace, with access permissions assigned by user groups. Workspaces can be bookmarked, and documents within a workspace can be made publicly accessible.
3. Features include document editing, viewing, commenting, attachment uploads, version history, page-level access control, and document search.
4. Document editing supports both HTML rich-text editing and Markdown editing.
5. Open-source technologies used by this tool include Vue, element-ui, mavon-editor, wangeditor, and others.
6. Developed with reference to Atlassian Confluence. The goal is to provide a free, open-source alternative to this software while also serving as an excellent internal documentation management tool.

zyplayer-doc-api API Documentation Management Tool

A management tool that supports centralized management of Swagger documentation, OpenAPI documentation, and custom API documentation. Features include document viewing, API requests, and global parameter management. Built with great attention to detail, the frontend uses the latest technologies. Every line of code has been written from scratch by hand. The code is extremely straightforward, clean, attractive, readable, and easy to maintain.

1. Supports Swagger documentation display and API debugging, with fast parsing and a thoughtfully designed interface.
2. Supports centralized management of all Swagger documentation, OpenAPI documentation, and custom API documentation, along with global parameter configuration, request parameter caching, automatic parameter filling on subsequent requests, and more.
3. The goal is to build a platform that provides centralized management of API documentation for all projects.

Other Features

1. zyplayer-doc-ui Frontend UI source code for the modules listed above
2. zyplayer-doc-core Core and shared classes
3. zyplayer-doc-data Database-level interactions
4. zyplayer-doc-other Tests and other related components

5. Tech Stack

Quick Startup

Database Requirements

You need to have a MySQL database. The recommended version is 5.7.25. Create a database named: zyplayer_doc_manage, then execute the SQL script to create the tables: Full Table Creation SQL.sql

Start using the main method

1. Modify the database username and password in the configuration file zyplayer-doc/zyplayer-doc-manage/src/main/resources/application.yml
2. Run the com.zyplayer.doc.manage.Application.main method to start the project. After startup, visit: [http://127.0.0.1:8083/zyplayer-doc-manage/](http://127.0.0.1:8083/zyplayer-doc-manage/)

Start using the JAR file

1. Direct Download: Download the precompiled JAR package directly from: [https://pan.baidu.com/s/1yMmnle01XR4TDjo2hfvw-Q](https://pan.baidu.com/s/1yMmnle01XR4TDjo2hfvw-Q) Extraction code: 3adf. Download the latest version and extract it.
2. Compile It Yourself: You can also compile the project yourself. Double-click zyplayer-doc\build.bat to use Maven to compile the entire project into an executable JAR file. The compiled files will be placed in the zyplayer-doc\dist\version folder. If Maven is not installed on your computer, you need to install it first.
3. Modify the database username and password in the application.yml file located in the output folder from Step 1 or Step 2.
4. Double-click startup.bat in the output folder from Step 1 or Step 2 to start the project. After startup, visit: [http://127.0.0.1:8083/zyplayer-doc-manage/](http://127.0.0.1:8083/zyplayer-doc-manage/)

Start Using a Tomcat Container

1. Download the precompiled WAR package directly from: [https://pan.baidu.com/s/1yMmnle01XR4TDjo2hfvw-Q](https://pan.baidu.com/s/1yMmnle01XR4TDjo2hfvw-Q) Extraction code: 3adf. Download the latest version and extract it.
2. Modify the database username and password in the configuration file: zyplayer-doc.zip\apache-tomcat\webapps\zyplayer-doc-manage\WEB-INF\classes\application.yml
3. Double-click tomcat\bin\startup.bat to start the application.

Default login username: zyplayer Password: 123456